org.johnnei.javatorrent.internal.utp.protocol

Class UtpAckHandler

java.lang.Object

org.johnnei.javatorrent.internal.utp.protocol.UtpAckHandler

public class UtpAckHandler
extends Object

A class which manages the tracking of which packets are still considered in flight.

Constructor Summary

Constructors

Constructor and Description
UtpAckHandler(UtpSocketImpl socket) Creates a new Utp Acknowledgement handler.

Method Summary

Modifier and Type	Method and Description
int	countBytesInFlight()
short	getAcknowledgeNumber()
boolean	hasPacketsInFlight()
boolean	isInitialised()
Optional<UtpPacket>	onReceivedPacket(UtpPacket receivedPacket) Event to be called on every packet we receive from the other end.
void	onReset() Event to be called when UtpProtocol.ST_RESET is received.
void	registerPacket(UtpPacket packet) Registers the we've sent a new packet.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UtpAckHandler

public UtpAckHandler(UtpSocketImpl socket)

Creates a new Utp Acknowledgement handler.

Parameters:

socket - The socket for which this handler is handling acknowledgements.

Method Detail

registerPacket

public void registerPacket(UtpPacket packet)

Registers the we've sent a new packet.

Parameters:

packet - The packet we've sent.

onReceivedPacket

public Optional<UtpPacket> onReceivedPacket(UtpPacket receivedPacket)
                                     throws IOException

Event to be called on every packet we receive from the other end.

Parameters:

receivedPacket - The packet we received.

Returns:

The packet which has been acked.

Throws:

IOException

onReset

public void onReset()

Event to be called when UtpProtocol.ST_RESET is received.

getAcknowledgeNumber

public short getAcknowledgeNumber()

Returns:

The latest packet which we've received in order from the other end.

countBytesInFlight

public int countBytesInFlight()

Returns:

The sum of all the packet sizes which have not yet been ACK'ed.

hasPacketsInFlight

public boolean hasPacketsInFlight()

Returns:

true when there is at least one packet in flight.

isInitialised

public boolean isInitialised()

Returns:

true when the socket has engaged with the handshake and thus has a base acknowledgeNumber set.

toString

public String toString()

Overrides:

toString in class Object