io.aeron.driver

Class UnicastFlowControl

java.lang.Object

io.aeron.driver.UnicastFlowControl

All Implemented Interfaces:

FlowControl

public class UnicastFlowControl
extends java.lang.Object
implements FlowControl

Default unicast sender flow control strategy. Max of right edges. No tracking of receivers.

Constructor Summary

Constructors

Constructor and Description
UnicastFlowControl()

Method Summary

Modifier and Type	Method and Description
void	initialize(int initialTermId, int termBufferCapacity) Initialize the flow control strategy
long	onIdle(long now, 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 now) 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

Constructor Detail

UnicastFlowControl

public UnicastFlowControl()

Method Detail

onStatusMessage

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

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

Specified by:

onStatusMessage in interface FlowControl

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.

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

Returns:

the new position limit to be employed by the sender.

initialize

public void initialize(int initialTermId,
                       int termBufferCapacity)

Initialize the flow control strategy

Specified by:

initialize in interface FlowControl

Parameters:

initialTermId - for the term buffers

termBufferCapacity - to use as the length of each term buffer

onIdle

public long onIdle(long now,
                   long senderLimit)

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

Specified by:

onIdle in interface FlowControl

Parameters:

now - time in nanoseconds.

senderLimit - for the current sender position.

Returns:

the position limit to be employed by the sender.