org.johnnei.javatorrent.internal.network.socket

Class UtpSocketImpl

java.lang.Object

org.johnnei.javatorrent.internal.network.socket.UtpSocketImpl

public class UtpSocketImpl
extends Object

Internal implementation of the UtpSocket

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UtpSocketImpl.Builder The class capable of building UtpSocketImpl instances progressively.

Constructor Summary

Constructors

Constructor and Description
UtpSocketImpl(UtpMultiplexer utpMultiplexer) Creates a new socket which is considered the initiating endpoint
UtpSocketImpl(UtpMultiplexer utpMultiplexer, SocketAddress socketAddress, short connectionId) Creates a new socket which is considered the accepting endpoint.

Method Summary

Modifier and Type	Method and Description
void	bindIoStreams(short sequenceNumber) Initialises the input and output stream of this socket.
void	close() Initiates the socket shutdown.
void	connect(InetSocketAddress endpoint) Attempts to connect the socket to the given endpoint.
short	getAcknowledgeNumber()
int	getBytesInFlight()
ConnectionState	getConnectionState()
short	getEndOfStreamSequenceNumber()
UtpInputStream	getInputStream()
int	getMeasuredDelay()
UtpOutputStream	getOutputStream()
int	getPacketSize()
short	getReceivingConnectionId()
short	getSendingConnectionId()
short	getSequenceNumber()
int	getWindowSize()
void	handleClose() Handles the period between ConnectionState.DISCONNECTING and ConnectionState.CLOSED.
void	handleTimeout() Handles the timeout case if one occurred.
boolean	isInputShutdown() Verifies if there is still the possibility that more packets are to be received.
boolean	isOutputShutdown() Verifies if data can still be written on this socket.
short	nextSequenceNumber()
void	onReceivedData() Called when a DataPayload has been received.
void	onReset() This method should be triggered when a RESET packet is received.
void	process(UtpPacket packet) Processes the payload of the given packet and updates the socket state accordingly.
void	send(IPayload payload) Writes the given payload with respect to the window.
void	sendUnbounded(UtpPacket packet) Send a packet without honoring the window.
void	setEndOfStreamSequenceNumber(short sequenceNumber)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UtpSocketImpl

public UtpSocketImpl(UtpMultiplexer utpMultiplexer)

Creates a new socket which is considered the initiating endpoint

Parameters:

utpMultiplexer - The multiplexer on which this socket will be registered.

UtpSocketImpl

public UtpSocketImpl(UtpMultiplexer utpMultiplexer,
                     SocketAddress socketAddress,
                     short connectionId)

Creates a new socket which is considered the accepting endpoint.

Parameters:

utpMultiplexer - The multiplexer on which this socket will be registered.

socketAddress - The socket address on which the remote end is listening.

connectionId - The connection id which we will use to send packets with.

Method Detail

connect

public void connect(InetSocketAddress endpoint)
             throws IOException

Attempts to connect the socket to the given endpoint.

Parameters:

endpoint - The address on which a client is expected to be listening.

Throws:

IOException - When the connection cannot be established.

send

public void send(IPayload payload)
          throws IOException

Writes the given payload with respect to the window.

Parameters:

payload - The payload to send.

Throws:

IOException - When an IO error occurs.

sendUnbounded

public void sendUnbounded(UtpPacket packet)
                   throws IOException

Send a packet without honoring the window.

Parameters:

packet - The packet

Throws:

IOException

See Also:

send(IPayload)

onReceivedData

public void onReceivedData()

Called when a DataPayload has been received.

getInputStream

public UtpInputStream getInputStream()
                              throws IOException

Throws:

IOException

getOutputStream

public UtpOutputStream getOutputStream()
                                throws IOException

Throws:

IOException

getBytesInFlight

public int getBytesInFlight()

process

public void process(UtpPacket packet)
             throws IOException

Processes the payload of the given packet and updates the socket state accordingly.

Parameters:

packet - The packet to process.

Throws:

IOException - When the payload cannot be processed.

onReset

public void onReset()
             throws IOException

This method should be triggered when a RESET packet is received.

Throws:

IOException

bindIoStreams

public void bindIoStreams(short sequenceNumber)

Initialises the input and output stream of this socket.

Parameters:

sequenceNumber - The sequence number of the packet which is the last packet of the connection establishment.

See Also:

getInputStream(), getOutputStream()

handleTimeout

public void handleTimeout()
                   throws IOException

Handles the timeout case if one occurred.

Throws:

IOException

handleClose

public void handleClose()

Handles the period between ConnectionState.DISCONNECTING and ConnectionState.CLOSED.

close

public void close()
           throws IOException

Initiates the socket shutdown.

Throws:

IOException

isInputShutdown

public boolean isInputShutdown()

Verifies if there is still the possibility that more packets are to be received.

Returns:

true when data can still be received, otherwise false.

isOutputShutdown

public boolean isOutputShutdown()

Verifies if data can still be written on this socket.

Returns:

true when data can still be written, otherwise false.

getAcknowledgeNumber

public short getAcknowledgeNumber()

nextSequenceNumber

public short nextSequenceNumber()

Returns:

The next unique sequence number to use to send out a packet.

getReceivingConnectionId

public short getReceivingConnectionId()

getSendingConnectionId

public short getSendingConnectionId()

getMeasuredDelay

public int getMeasuredDelay()

getWindowSize

public int getWindowSize()

getPacketSize

public int getPacketSize()

getConnectionState

public ConnectionState getConnectionState()

setEndOfStreamSequenceNumber

public void setEndOfStreamSequenceNumber(short sequenceNumber)

getEndOfStreamSequenceNumber

public short getEndOfStreamSequenceNumber()

getSequenceNumber

public short getSequenceNumber()

toString

public String toString()

Overrides:

toString in class Object