io.zeebe.transport

Interface ClientOutput

All Known Implementing Classes:

ClientOutputImpl

public interface ClientOutput

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 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 sendRequest(RemoteAddress, BufferWriter) but retries the request if there is no current connection.

Method Detail

sendMessage

boolean sendMessage(TransportMessage transportMessage)

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).

sendRequest

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

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)

sendRequestWithRetry

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

Like 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)

Parameters:

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

sendRequestWithRetry

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

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