io.aeron.driver

Interface CongestionControl

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

CubicCongestionControl, StaticWindowCongestionControl

public interface CongestionControl
extends java.lang.AutoCloseable

Strategy for applying congestion control to determine the receiverWindowLength of the Status Messages

Method Summary

Modifier and Type	Method and Description
void	close()
int	initialWindowLength() Called by DriverConductor to initialise window length for a new PublicationImage.
void	onRttMeasurement(long nowNs, long rttNs, java.net.InetSocketAddress srcAddress) Called by Receiver on reception of an RTT Measurement.
void	onRttMeasurementSent(long nowNs) Called by Receiver to record that a measurement request has been sent.
long	onTrackRebuild(long nowNs, long newConsumptionPosition, long lastSmPosition, long hwmPosition, long startingRebuildPosition, long endingRebuildPosition, boolean lossOccurred) Called by DriverConductor upon execution of PublicationImage.trackRebuild(long, long) to pass on current status.
boolean	shouldMeasureRtt(long nowNs) Polled by Receiver to determine when to initiate an RTT measurement to a Sender.

Method Detail

shouldMeasureRtt

boolean shouldMeasureRtt(long nowNs)

Polled by Receiver to determine when to initiate an RTT measurement to a Sender.

Parameters:

nowNs - in nanoseconds

Returns:

true for should measure RTT now or false for no measurement

onRttMeasurementSent

void onRttMeasurementSent(long nowNs)

Called by Receiver to record that a measurement request has been sent.

Parameters:

nowNs - in nanoseconds.

onRttMeasurement

void onRttMeasurement(long nowNs,
                      long rttNs,
                      java.net.InetSocketAddress srcAddress)

Called by Receiver on reception of an RTT Measurement.

Parameters:

nowNs - in nanoseconds

rttNs - to the Sender in nanoseconds

srcAddress - of the Sender

onTrackRebuild

long onTrackRebuild(long nowNs,
                    long newConsumptionPosition,
                    long lastSmPosition,
                    long hwmPosition,
                    long startingRebuildPosition,
                    long endingRebuildPosition,
                    boolean lossOccurred)

Called by DriverConductor upon execution of PublicationImage.trackRebuild(long, long) to pass on current status.

The return value must be packed using CongestionControlUtil.packOutcome(int, boolean).

Parameters:

nowNs - in nanoseconds

newConsumptionPosition - of the Subscribers

lastSmPosition - of the image

hwmPosition - of the image

startingRebuildPosition - of the rebuild

endingRebuildPosition - of the rebuild

lossOccurred - during rebuild

Returns:

outcome of congestion control calculation containing window length and whether to force sending an SM.

initialWindowLength

int initialWindowLength()

Called by DriverConductor to initialise window length for a new PublicationImage.

Returns:

new image window length

close

void close()

Specified by:

close in interface java.lang.AutoCloseable