io.aeron.driver

Interface FlowControl

All Known Implementing Classes:

MaxMulticastFlowControl, MinMulticastFlowControl, PreferredMulticastFlowControl, 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 nowNs, long senderLimit) Perform any maintenance needed by the flow control strategy and return current position
long	onStatusMessage(io.aeron.protocol.StatusMessageFlyweight flyweight, java.net.InetSocketAddress receiverAddress, long senderLimit, int initialTermId, int positionBitsToShift, long nowNs) Update the sender flow control strategy based on a status message from the receiver.

Method Detail

onStatusMessage

long onStatusMessage(io.aeron.protocol.StatusMessageFlyweight flyweight,
                     java.net.InetSocketAddress receiverAddress,
                     long senderLimit,
                     int initialTermId,
                     int positionBitsToShift,
                     long nowNs)

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

Parameters:

flyweight - the Status Message contents

receiverAddress - of the receiver.

senderLimit - the current sender position limit.

initialTermId - for the term buffers.

positionBitsToShift - in use for the length of each term buffer.

nowNs - current nano clock time (in nanoseconds). System.nanoTime()

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 nowNs,
            long senderLimit)

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

Parameters:

nowNs - time in nanoseconds.

senderLimit - for the current sender position.

Returns:

the position limit to be employed by the sender.