io.zeebe.transport

Class ClientTransportBuilder

java.lang.Object

io.zeebe.transport.ClientTransportBuilder

public class ClientTransportBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected TransportChannelFactory	channelFactory
protected static long	DEFAULT_CHANNEL_CONNECT_TIMEOUT
protected static long	DEFAULT_CHANNEL_KEEP_ALIVE_PERIOD In the same order of magnitude of what apache and nginx use.
protected long	defaultRequestRetryTimeout
protected boolean	enableManagedRequests
protected long	keepAlivePeriod
protected List<ClientInputListener>	listeners
protected io.zeebe.dispatcher.Dispatcher	receiveBuffer
static String	SEND_BUFFER_SUBSCRIPTION_NAME

Constructor Summary

Constructors

Constructor and Description
ClientTransportBuilder()

Method Summary

Modifier and Type	Method and Description
ClientTransport	build()
protected ClientTransport	build(TransportContext context)
protected TransportContext	buildTransportContext(ClientOutput output, ClientRequestPool clientRequestPool, RequestManager requestManager, RemoteAddressListImpl addressList, io.zeebe.dispatcher.FragmentHandler receiveHandler, io.zeebe.dispatcher.Dispatcher receiveBuffer)
ClientTransportBuilder	channelFactory(TransportChannelFactory channelFactory)
ClientTransportBuilder	defaultRequestRetryTimeout(java.time.Duration duration)
ClientTransportBuilder	enableManagedRequests() Enables APIs like ClientOutput.sendRequestWithRetry(RemoteAddress, io.zeebe.util.buffer.BufferWriter).
ClientTransportBuilder	inputListener(ClientInputListener listener)
ClientTransportBuilder	keepAlivePeriod(long keepAlivePeriod) The period in which a dummy message is sent to keep the underlying TCP connection open.
ClientTransportBuilder	messageMaxLength(int messageMaxLength)
ClientTransportBuilder	messageReceiveBuffer(io.zeebe.dispatcher.Dispatcher receiveBuffer) Optional.
ClientTransportBuilder	requestPoolSize(int requestPoolSize) Maximum number of concurrent requests.
ClientTransportBuilder	scheduler(io.zeebe.util.actor.ActorScheduler scheduler)
ClientTransportBuilder	sendBuffer(io.zeebe.dispatcher.Dispatcher sendBuffer) Send buffer must have an open subscription named SEND_BUFFER_SUBSCRIPTION_NAME.

Methods inherited from class java.lang.Object

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

Field Detail

SEND_BUFFER_SUBSCRIPTION_NAME

public static final String SEND_BUFFER_SUBSCRIPTION_NAME

See Also:

Constant Field Values

DEFAULT_CHANNEL_KEEP_ALIVE_PERIOD

protected static final long DEFAULT_CHANNEL_KEEP_ALIVE_PERIOD

In the same order of magnitude of what apache and nginx use.

See Also:

Constant Field Values

DEFAULT_CHANNEL_CONNECT_TIMEOUT

protected static final long DEFAULT_CHANNEL_CONNECT_TIMEOUT

See Also:

Constant Field Values

keepAlivePeriod

protected long keepAlivePeriod

receiveBuffer

protected io.zeebe.dispatcher.Dispatcher receiveBuffer

listeners

protected List<ClientInputListener> listeners

channelFactory

protected TransportChannelFactory channelFactory

enableManagedRequests

protected boolean enableManagedRequests

defaultRequestRetryTimeout

protected long defaultRequestRetryTimeout

Constructor Detail

ClientTransportBuilder

public ClientTransportBuilder()

Method Detail

scheduler

public ClientTransportBuilder scheduler(io.zeebe.util.actor.ActorScheduler scheduler)

messageReceiveBuffer

public ClientTransportBuilder messageReceiveBuffer(io.zeebe.dispatcher.Dispatcher receiveBuffer)

Optional. If set, all incoming messages (single-message protocol) are put onto the provided buffer. ClientTransport.openSubscription(String, ClientMessageHandler) can be used to consume from this buffer.

inputListener

public ClientTransportBuilder inputListener(ClientInputListener listener)

sendBuffer

public ClientTransportBuilder sendBuffer(io.zeebe.dispatcher.Dispatcher sendBuffer)

Send buffer must have an open subscription named SEND_BUFFER_SUBSCRIPTION_NAME.

messageMaxLength

public ClientTransportBuilder messageMaxLength(int messageMaxLength)

requestPoolSize

public ClientTransportBuilder requestPoolSize(int requestPoolSize)

Maximum number of concurrent requests.

keepAlivePeriod

public ClientTransportBuilder keepAlivePeriod(long keepAlivePeriod)

The period in which a dummy message is sent to keep the underlying TCP connection open.

channelFactory

public ClientTransportBuilder channelFactory(TransportChannelFactory channelFactory)

enableManagedRequests

public ClientTransportBuilder enableManagedRequests()

Enables APIs like ClientOutput.sendRequestWithRetry(RemoteAddress, io.zeebe.util.buffer.BufferWriter). Requires running another actor, so you can keep this disabled if you don't use the APIs.

defaultRequestRetryTimeout

public ClientTransportBuilder defaultRequestRetryTimeout(java.time.Duration duration)

build

public ClientTransport build()

buildTransportContext

protected TransportContext buildTransportContext(ClientOutput output,
                                                 ClientRequestPool clientRequestPool,
                                                 RequestManager requestManager,
                                                 RemoteAddressListImpl addressList,
                                                 io.zeebe.dispatcher.FragmentHandler receiveHandler,
                                                 io.zeebe.dispatcher.Dispatcher receiveBuffer)

build

protected ClientTransport build(TransportContext context)