Package io.aeron.driver

Class TaggedMulticastFlowControl

java.lang.Object

io.aeron.driver.AbstractMinMulticastFlowControl

io.aeron.driver.TaggedMulticastFlowControl

All Implemented Interfaces:

FlowControl, AutoCloseable

Direct Known Subclasses:

PreferredMulticastFlowControl

public class TaggedMulticastFlowControl
extends AbstractMinMulticastFlowControl

Minimum multicast sender flow control strategy only for tagged members identified by a receiver tag or ASF key.

Flow control is set to minimum of tracked tagged receivers.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FC_PARAM_VALUE	URI param value to identify this FlowControl strategy.

Method Summary

Modifier and Type	Method	Description
void	onError(ErrorFlyweight errorFlyweight, InetSocketAddress receiverAddress, long timeNs)	Update the sender flow control strategy if an error comes from one of the receivers.
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.
void	onTriggerSendSetup(StatusMessageFlyweight flyweight, InetSocketAddress receiverAddress, long timeNs)	Update the sender flow control strategy based on a Status Message received triggering a setup to be sent.

Methods inherited from class io.aeron.driver.AbstractMinMulticastFlowControl

close, groupMinSize, groupTag, hasGroupTag, hasRequiredReceivers, initialize, maxRetransmissionLength, onIdle, onSetup, processError, processSendSetupTrigger, processStatusMessage, receiverTimeoutNs

Methods inherited from class java.lang.Object

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

Field Details

FC_PARAM_VALUE

public static final String FC_PARAM_VALUE

URI param value to identify this FlowControl strategy.

See Also:

• Constant Field Values

Method Details

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.

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.

onTriggerSendSetup

public void onTriggerSendSetup(StatusMessageFlyweight flyweight,
 InetSocketAddress receiverAddress,
 long timeNs)

Update the sender flow control strategy based on a Status Message received triggering a setup to be sent.

Parameters:

flyweight - over the Status Message received

receiverAddress - of the receiver.

timeNs - current time (in nanoseconds).

onError

public void onError(ErrorFlyweight errorFlyweight,
 InetSocketAddress receiverAddress,
 long timeNs)

Update the sender flow control strategy if an error comes from one of the receivers.

Parameters:

errorFlyweight - over the error received.

receiverAddress - the address of the receiver.

timeNs - current time in nanoseconds