io.aeron.driver

Class UnicastFlowControl

java.lang.Object

io.aeron.driver.UnicastFlowControl

All Implemented Interfaces:

FlowControl

public class UnicastFlowControl
extends Object
implements FlowControl

Default unicast sender flow control strategy.

Max of right edges. No tracking of receivers.

Field Summary

Fields

Modifier and Type	Field and Description
static UnicastFlowControl	INSTANCE Singleton instance which can be used to avoid allocation.

Constructor Summary

Constructors

Constructor and Description
UnicastFlowControl()

Method Summary

Modifier and Type	Method and Description
void	initialize(MediaDriver.Context context, UdpChannel udpChannel, int initialTermId, int termBufferLength) Initialize the flow control strategy for a stream.
long	onIdle(long timeNs, long senderLimit, long senderPosition, boolean isEos) Perform any maintenance needed by the flow control strategy and return current sender limit position.
long	onStatusMessage(StatusMessageFlyweight flyweight, InetSocketAddress receiverAddress, long senderLimit, int initialTermId, int positionBitsToShift, long timeNs) Update the sender flow control strategy based on a status message from the receiver.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.aeron.driver.FlowControl

hasRequiredReceivers

Field Detail

INSTANCE

public static final UnicastFlowControl INSTANCE

Singleton instance which can be used to avoid allocation.

Constructor Detail

UnicastFlowControl

public UnicastFlowControl()

Method Detail

onStatusMessage

public long onStatusMessage(StatusMessageFlyweight flyweight,
                            InetSocketAddress receiverAddress,
                            long senderLimit,
                            int initialTermId,
                            int positionBitsToShift,
                            long timeNs)

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

Specified by:

onStatusMessage in interface FlowControl

Parameters:

flyweight - over the status message received.

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.

timeNs - current time (in nanoseconds).

Returns:

the new position limit to be employed by the sender.

initialize

public void initialize(MediaDriver.Context context,
                       UdpChannel udpChannel,
                       int initialTermId,
                       int termBufferLength)

Initialize the flow control strategy for a stream.

Specified by:

initialize in interface FlowControl

Parameters:

context - to allow access to media driver configuration

udpChannel - for the stream.

initialTermId - at which the stream started.

termBufferLength - to use as the length of each term buffer.

onIdle

public long onIdle(long timeNs,
                   long senderLimit,
                   long senderPosition,
                   boolean isEos)

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

Specified by:

onIdle in interface FlowControl

Parameters:

timeNs - current time in nanoseconds.

senderLimit - for the current sender position.

senderPosition - which has been sent.

isEos - is this end-of-stream for the sender.

Returns:

the position limit to be employed by the sender.