io.zeebe.transport

Class ClientTransport

java.lang.Object

io.zeebe.transport.ClientTransport

All Implemented Interfaces:

AutoCloseable

public class ClientTransport
extends Object
implements AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ClientTransport.ClientInputMessageSubscriptionImpl

Constructor Summary

Constructors

Constructor and Description
ClientTransport(ActorContext transportActorContext, TransportContext transportContext)

Method Summary

Modifier and Type	Method and Description
void	close()
CompletableFuture<Void>	closeAllChannels()
CompletableFuture<Void>	closeAsync()
void	deactivateRemoteAddress(RemoteAddress remote) Signals that the remote is no longer in use for the time being.
long	getChannelKeepAlivePeriod()
ClientOutput	getOutput()
RemoteAddress	getRemoteAddress(int streamId)
RemoteAddress	getRemoteAddress(SocketAddress addr)
void	interruptAllChannels()
CompletableFuture<ClientInputMessageSubscription>	openSubscription(String subscriptionName, ClientMessageHandler messageHandler) Creates a subscription on the receive buffer for single messages.
CompletableFuture<Void>	registerChannelListener(TransportListener channelListener) Registers a listener with callbacks for whenever a connection to a remote gets established or closed.
RemoteAddress	registerRemoteAddress(SocketAddress addr) Resolve a socket address as a remote to which data can be sent.
RemoteAddress	registerRemoteAndAwaitChannel(SocketAddress addr) DO NOT USE in production code as it involves blocking the current thread.
void	removeChannelListener(TransportListener listener)
void	retireRemoteAddress(RemoteAddress remote) Signals that the remote is no longer used and that the stream should not be reused on reactivation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientTransport

public ClientTransport(ActorContext transportActorContext,
                       TransportContext transportContext)

Method Detail

getOutput

public ClientOutput getOutput()

Returns:

interface to stage outbound data

registerRemoteAddress

public RemoteAddress registerRemoteAddress(SocketAddress addr)

Resolve a socket address as a remote to which data can be sent. The return value identifies the remote and remains stable throughout the lifetime of this ClientTransport object, i.e. can be cached. Transport will make sure to keep an open channel to this remote until the address is deactivated or retired.

deactivateRemoteAddress

public void deactivateRemoteAddress(RemoteAddress remote)

Signals that the remote is no longer in use for the time being. A transport channel will no longer be managed. A remote address is reactivated when the endpoint is registered again.

retireRemoteAddress

public void retireRemoteAddress(RemoteAddress remote)

Signals that the remote is no longer used and that the stream should not be reused on reactivation. That means, when the endpoint is registered again, it is assigned a different stream id (=> a new remote address is returned).

Parameters:

remote -

registerRemoteAndAwaitChannel

public RemoteAddress registerRemoteAndAwaitChannel(SocketAddress addr)

DO NOT USE in production code as it involves blocking the current thread.

Not thread-safe

Like registerRemoteAddress(SocketAddress) but blockingly waits for the corresponding channel to be opened such that it is probable that subsequent requests/messages can be sent. This saves test code the need to retry sending.

getRemoteAddress

public RemoteAddress getRemoteAddress(SocketAddress addr)

getRemoteAddress

public RemoteAddress getRemoteAddress(int streamId)

openSubscription

public CompletableFuture<ClientInputMessageSubscription> openSubscription(String subscriptionName,
                                                                          ClientMessageHandler messageHandler)

Creates a subscription on the receive buffer for single messages.

Throws:

RuntimeException - if this client was not created with a receive buffer for single-messages

registerChannelListener

public CompletableFuture<Void> registerChannelListener(TransportListener channelListener)

Registers a listener with callbacks for whenever a connection to a remote gets established or closed.

removeChannelListener

public void removeChannelListener(TransportListener listener)

closeAsync

public CompletableFuture<Void> closeAsync()

close

public void close()

Specified by:

close in interface AutoCloseable

interruptAllChannels

public void interruptAllChannels()

closeAllChannels

public CompletableFuture<Void> closeAllChannels()

getChannelKeepAlivePeriod

public long getChannelKeepAlivePeriod()