io.zeebe.transport.impl

Class ClientOutputImpl

java.lang.Object

io.zeebe.transport.impl.ClientOutputImpl

All Implemented Interfaces:

ClientOutput

public class ClientOutputImpl
extends Object
implements ClientOutput

Field Summary

Fields

Modifier and Type	Field and Description
protected long	defaultRequestRetryTimeout
protected RequestManager	requestManager
protected ClientRequestPool	requestPool
protected io.zeebe.dispatcher.Dispatcher	sendBuffer

Constructor Summary

Constructors

Constructor and Description
ClientOutputImpl(io.zeebe.dispatcher.Dispatcher sendBuffer, ClientRequestPool requestPool, RequestManager requestManager, long defaultRequestRetryTimeout)

Method Summary

Modifier and Type	Method and Description
boolean	sendMessage(TransportMessage transportMessage) Sends a message according to the single message protocol.
ClientRequest	sendRequest(RemoteAddress addr, io.zeebe.util.buffer.BufferWriter writer) Sends a request according to the request response protocol to a given remote
ClientRequest	sendRequestWithRetry(RemoteAddress addr, io.zeebe.util.buffer.BufferWriter writer) Same as ClientOutput.sendRequestWithRetry(RemoteAddress, BufferWriter, long) where the timeout is set to the configured default timeout.
ClientRequest	sendRequestWithRetry(RemoteAddress addr, io.zeebe.util.buffer.BufferWriter writer, long timeout) Like ClientOutput.sendRequest(RemoteAddress, BufferWriter) but retries the request if there is no current connection.

Methods inherited from class java.lang.Object

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

Field Detail

sendBuffer

protected final io.zeebe.dispatcher.Dispatcher sendBuffer

requestPool

protected final ClientRequestPool requestPool

requestManager

protected final RequestManager requestManager

defaultRequestRetryTimeout

protected final long defaultRequestRetryTimeout

Constructor Detail

ClientOutputImpl

public ClientOutputImpl(io.zeebe.dispatcher.Dispatcher sendBuffer,
                        ClientRequestPool requestPool,
                        RequestManager requestManager,
                        long defaultRequestRetryTimeout)

Method Detail

sendMessage

public boolean sendMessage(TransportMessage transportMessage)

Description copied from interface: ClientOutput

Sends a message according to the single message protocol.

Returns false if the message cannot be currently written due to exhausted capacity. Throws an exception if the request is not sendable at all (e.g. buffer writer throws exception).

Specified by:

sendMessage in interface ClientOutput

sendRequest

public ClientRequest sendRequest(RemoteAddress addr,
                                 io.zeebe.util.buffer.BufferWriter writer)

Description copied from interface: ClientOutput

Sends a request according to the request response protocol to a given remote

Returns null if request cannot be currently written to the send buffer due to exhausted capacity.

Throws an exception if the request is not sendable at all (e.g. buffer writer throws exception).

Returns a future to the response content else.

The future throws fails with NotConnectedException if the addressed remote is currently not connected.

The returned request object MUST be closed when it is not needed anymore.

Guarantees:

• Garbage-free
• One intermediary copy of the request (on the send buffer)

Specified by:

sendRequest in interface ClientOutput

sendRequestWithRetry

public ClientRequest sendRequestWithRetry(RemoteAddress addr,
                                          io.zeebe.util.buffer.BufferWriter writer,
                                          long timeout)

Description copied from interface: ClientOutput

Like ClientOutput.sendRequest(RemoteAddress, BufferWriter) but retries the request if there is no current connection. Makes this method more robust in the presence of short intermittent disconnects.

Guarantees:

• Not garbage-free
• n intermediary copies of the request (one local copy for making retries, one copy on the send buffer per try)

Specified by:

sendRequestWithRetry in interface ClientOutput

timeout - Timeout in milliseconds until the returned future fails if no response is received.

sendRequestWithRetry

public ClientRequest sendRequestWithRetry(RemoteAddress addr,
                                          io.zeebe.util.buffer.BufferWriter writer)

Description copied from interface: ClientOutput

Same as ClientOutput.sendRequestWithRetry(RemoteAddress, BufferWriter, long) where the timeout is set to the configured default timeout.

Specified by:

sendRequestWithRetry in interface ClientOutput