Skip to content

Commit

Permalink
[Java] Fix typos in Javadoc.
Browse files Browse the repository at this point in the history
mjpt777 committed Jan 9, 2017
1 parent a5e9526 commit c11d09f
Showing 2 changed files with 13 additions and 14 deletions.
24 changes: 12 additions & 12 deletions aeron-driver/src/main/java/io/aeron/driver/CongestionControl.java
Original file line number Diff line number Diff line change
@@ -33,38 +33,38 @@ public interface CongestionControl
/**
* Called by {@link Receiver} on reception of an RTT Measurement.
*
* @param now in nanoseconds
* @param now in nanoseconds
* @param rttInNanos to the Sender
* @param srcAddress of the Sender
*/
void onRttMeasurement(long now, long rttInNanos, InetSocketAddress srcAddress);

/**
* Called by {@link DriverConductor} upon execution of {@link PublicationImage#trackRebuild(long, long)} to
* pass on current status.
* Called by {@link DriverConductor} upon execution of {@link PublicationImage#trackRebuild(long, long)} to
* pass on current status.
*
* The return value must be packed using {@link CongestionControlUtil#packOutcome(int, boolean)}.
* The return value must be packed using {@link CongestionControlUtil#packOutcome(int, boolean)}.
*
* @param now in nanoseconds
* @param newConsumptiopnPosition of the Subscribers
* @param lastSmPosition of the image
* @param hwmPosition of the image
* @param now in nanoseconds
* @param newConsumptionPosition of the Subscribers
* @param lastSmPosition of the image
* @param hwmPosition of the image
* @param startingRebuildPosition of the rebuild
* @param endingRebuildPosition of the rebuild
* @param lossOccurred during rebuild
* @param endingRebuildPosition of the rebuild
* @param lossOccurred during rebuild
* @return outcome of congestion control calculation containing window length and whether to force sending an SM.
*/
long onTrackRebuild(
long now,
long newConsumptiopnPosition,
long newConsumptionPosition,
long lastSmPosition,
long hwmPosition,
long startingRebuildPosition,
long endingRebuildPosition,
boolean lossOccurred);

/**
* Called by {@link DriverConductor} to initialize window length for a new Image.
* Called by {@link DriverConductor} to initialise window length for a new {@link PublicationImage}.
*
* @return new image window length
*/
Original file line number Diff line number Diff line change
@@ -35,7 +35,6 @@ public StaticWindowCongestionControl(
ccOutcome = CongestionControlUtil.packOutcome(Math.min(termLength / 2, context.initialWindowLength()), false);
}


public boolean shouldMeasureRtt(final long now)
{
return false;
@@ -47,7 +46,7 @@ public void onRttMeasurement(final long now, final long rttInNanos, final InetSo

public long onTrackRebuild(
final long now,
final long newConsumptiopnPosition,
final long newConsumptionPosition,
final long lastSmPosition,
final long hwmPosition,
final long startingRebuildPosition,

0 comments on commit c11d09f

Please sign in to comment.