io.aeron.driver

Interface FlowControl

All Known Implementing Classes:

MaxMulticastFlowControl, UnicastFlowControl

public interface FlowControl

Strategy for applying flow control to the Sender.

Method Summary

Modifier and Type	Method and Description
void	initialize(int initialTermId, int termBufferCapacity) Initialize the flow control strategy
long	onIdle(long now) Perform any maintenance needed by the flow control strategy and return current position
long	onStatusMessage(int termId, int termOffset, int receiverWindowLength, java.net.InetSocketAddress address) Update the sender flow control strategy based on a status message from the receiver.

Method Detail

onStatusMessage

long onStatusMessage(int termId,
                     int termOffset,
                     int receiverWindowLength,
                     java.net.InetSocketAddress address)

Update the sender flow control strategy based on a status message from the receiver.

Parameters:

termId - currently active for the receiver.

termOffset - within the current active term for the receiver.

receiverWindowLength - supported by the receiver.

address - of the receiver.

Returns:

the new position limit to be employed by the sender.

initialize

void initialize(int initialTermId,
                int termBufferCapacity)

Initialize the flow control strategy

Parameters:

initialTermId - for the term buffers

termBufferCapacity - to use as the length of each term buffer

onIdle

long onIdle(long now)

Perform any maintenance needed by the flow control strategy and return current position

Parameters:

now - time in nanoseconds.

Returns:

the position limit to be employed by the sender.