org.johnnei.javatorrent.internal.utp.protocol

Class UtpPacket

java.lang.Object

org.johnnei.javatorrent.internal.utp.protocol.UtpPacket

public class UtpPacket
extends Object

The header section of an UTP packet.

Constructor Summary

Constructors

Constructor and Description
UtpPacket()
UtpPacket(UtpSocketImpl socket, IPayload payload) Creates a new UtpPacket which will be send.
UtpPacket(UtpSocketImpl socket, IPayload payload, boolean isSynResponse) Creates a new UtpPacket which will be send.

Method Summary

Modifier and Type	Method and Description
short	getAcknowledgeNumber()
short	getConnectionId()
int	getPacketSize()
int	getSentTime()
short	getSequenceNumber()
int	getTimesSent()
int	getTimestampDifferenceMicroseconds()
int	getTimestampMicroseconds()
byte	getType()
byte	getVersion()
int	getWindowSize()
boolean	hasExtensions()
void	processPayload(UtpSocketImpl socket) Processes the payload information.
void	read(InStream inStream, UtpPayloadFactory payloadFactory) Reads the packet including the payload.
byte[]	repackage(UtpSocketImpl socket) Modifies this packet to become half the size of the original size.
String	toString()
void	updateSentTime() Updates the time at which this packet was sent and increments the amount of times it is send.
void	write(UtpSocketImpl socket, OutStream outStream) Writes the packet including the payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

UtpPacket

public UtpPacket()

UtpPacket

public UtpPacket(UtpSocketImpl socket,
                 IPayload payload)

Creates a new UtpPacket which will be send.

Parameters:

socket - The socket on which this packet will be send.

payload - The payload which will be send with this packet.

UtpPacket

public UtpPacket(UtpSocketImpl socket,
                 IPayload payload,
                 boolean isSynResponse)

Creates a new UtpPacket which will be send.

Parameters:

socket - The socket on which this packet will be send.

payload - The payload which will be send with this packet.

isSynResponse - If this packet is a repsonse to SynPayload.

Method Detail

read

public void read(InStream inStream,
                 UtpPayloadFactory payloadFactory)

Reads the packet including the payload.

Parameters:

inStream - The stream from which the packet must be read.

payloadFactory - The payload factory to read the payload data.

write

public void write(UtpSocketImpl socket,
                  OutStream outStream)

Writes the packet including the payload.

Parameters:

socket - The socket for which this packet will be written.

outStream - The stream on which the packet will be written.

repackage

public byte[] repackage(UtpSocketImpl socket)

Modifies this packet to become half the size of the original size.

Parameters:

socket - The socket on which this packet is being send.

Returns:

The bytes which are no longer being sent by this packet.

updateSentTime

public void updateSentTime()

Updates the time at which this packet was sent and increments the amount of times it is send.

processPayload

public void processPayload(UtpSocketImpl socket)
                    throws IOException

Processes the payload information.

Parameters:

socket - The socket which received the packet.

Throws:

IOException

getConnectionId

public short getConnectionId()

Returns:

The connection ID for this packet.

getAcknowledgeNumber

public short getAcknowledgeNumber()

Returns:

The last packet which was received.

getSequenceNumber

public short getSequenceNumber()

Returns:

The sequence number of this packet.

getWindowSize

public int getWindowSize()

Returns:

The advertised window size.

getTimestampMicroseconds

public int getTimestampMicroseconds()

Returns:

The timestamp at which this packet was sent.

getTimestampDifferenceMicroseconds

public int getTimestampDifferenceMicroseconds()

Returns:

The measured difference between packet timestamp and local timestamp.

hasExtensions

public boolean hasExtensions()

Returns:

true when the extension indication field is non-zero.

getVersion

public byte getVersion()

Returns:

The protocol version of this packet.

getPacketSize

public int getPacketSize()

Returns:

The size of the packet including the payload size.

getSentTime

public int getSentTime()

Returns:

The time at which this packet was sent.

getTimesSent

public int getTimesSent()

Returns:

The amount of times this packet was sent.

getType

public byte getType()

Returns:

The type of packet.

See Also:

UtpProtocol

toString

public String toString()

Overrides:

toString in class Object