io.aeron.driver

Class PreferredMulticastFlowControl

java.lang.Object

io.aeron.driver.PreferredMulticastFlowControl

All Implemented Interfaces:

FlowControl

public class PreferredMulticastFlowControl
extends java.lang.Object
implements FlowControl

Minimum multicast sender flow control strategy only for preferred members.

Flow control is set to minimum of tracked preferred receivers.

Tracking of preferred receivers is done as long as they continue to send Status Messages. Once SMs stop, the receiver tracking for that receiver will timeout after a given number of nanoseconds.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFERRED_ASF
static byte[]	PREFERRED_ASF_BYTES
static java.lang.String	PREFERRED_ASF_DEFAULT Default Application Specific Feedback (ASF) value
static java.lang.String	PREFERRED_ASF_PROP_NAME Property name used to set Application Specific Feedback (ASF) in Status Messages to identify preferred receivers.
static long	RECEIVER_TIMEOUT
static long	RECEIVER_TIMEOUT_DEFAULT Default timeout, in nanoseconds, until a receiver is no longer tracked and considered for minimum.
static java.lang.String	RECEIVER_TIMEOUT_PROP_NAME Property name to set timeout, in nanoseconds, for a receiver to be tracked.

Constructor Summary

Constructors

Constructor and Description
PreferredMulticastFlowControl()

Method Summary

Modifier and Type	Method and Description
void	initialize(int initialTermId, int termBufferLength) Initialize the flow control strategy
boolean	isFromPreferred(StatusMessageFlyweight statusMessageFlyweight)
long	onIdle(long timeNs, long senderLimit, long senderPosition, boolean isEos) Perform any maintenance needed by the flow control strategy and return current position
long	onStatusMessage(StatusMessageFlyweight flyweight, java.net.InetSocketAddress receiverAddress, long senderLimit, int initialTermId, int positionBitsToShift, long timeNs) Update the sender flow control strategy based on a status message from the receiver.
boolean	shouldLinger(long timeNs) Called from the DriverConductor to check should the NetworkPublication linger or not.

Methods inherited from class java.lang.Object

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

Field Detail

RECEIVER_TIMEOUT_PROP_NAME

public static final java.lang.String RECEIVER_TIMEOUT_PROP_NAME

Property name to set timeout, in nanoseconds, for a receiver to be tracked.

See Also:

Constant Field Values

RECEIVER_TIMEOUT_DEFAULT

public static final long RECEIVER_TIMEOUT_DEFAULT

Default timeout, in nanoseconds, until a receiver is no longer tracked and considered for minimum.

RECEIVER_TIMEOUT

public static final long RECEIVER_TIMEOUT

PREFERRED_ASF_PROP_NAME

public static final java.lang.String PREFERRED_ASF_PROP_NAME

Property name used to set Application Specific Feedback (ASF) in Status Messages to identify preferred receivers.

See Also:

Constant Field Values

PREFERRED_ASF_DEFAULT

public static final java.lang.String PREFERRED_ASF_DEFAULT

Default Application Specific Feedback (ASF) value

See Also:

Constant Field Values

PREFERRED_ASF

public static final java.lang.String PREFERRED_ASF

PREFERRED_ASF_BYTES

public static final byte[] PREFERRED_ASF_BYTES

Constructor Detail

PreferredMulticastFlowControl

public PreferredMulticastFlowControl()

Method Detail

onStatusMessage

public long onStatusMessage(StatusMessageFlyweight flyweight,
                            java.net.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 - 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.

timeNs - current time (in nanoseconds). System.nanoTime()

Returns:

the new position limit to be employed by the sender.

initialize

public void initialize(int initialTermId,
                       int termBufferLength)

Initialize the flow control strategy

Specified by:

initialize in interface FlowControl

Parameters:

initialTermId - for the term buffers

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 position

Specified by:

onIdle in interface FlowControl

Parameters:

timeNs - current time in nanoseconds.

senderLimit - for the current sender position.

senderPosition - for the current

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

Returns:

the position limit to be employed by the sender.

shouldLinger

public boolean shouldLinger(long timeNs)

Called from the DriverConductor to check should the NetworkPublication linger or not.

Specified by:

shouldLinger in interface FlowControl

Parameters:

timeNs - current time in nanoseconds.

Returns:

true to continue to linger or false to not linger

isFromPreferred

public boolean isFromPreferred(StatusMessageFlyweight statusMessageFlyweight)