org.johnnei.javatorrent.network

Class BitTorrentSocket

java.lang.Object

org.johnnei.javatorrent.network.BitTorrentSocket

public class BitTorrentSocket
extends Object

Constructor Summary

Constructors

Constructor and Description
BitTorrentSocket(MessageFactory messageFactory) Creates a new unbound BitTorrent socket.
BitTorrentSocket(MessageFactory messageFactory, ISocket socket) Creates a new bound BitTorrent socket.

Method Summary

Modifier and Type	Method and Description
boolean	canReadMessage() Buffers the next message for reading.
void	close() Closes the connection with the socket
boolean	closed() Checks if the socket is closed
void	connect(ConnectionDegradation degradation, InetSocketAddress address) Attempts to connect to the given endpoint in a blocking manner.
void	enqueueMessage(IMessage message) Queues the message to be send
int	getDownloadRate() Returns the last polled download rate.
LocalDateTime	getLastActivity() Gets the time at which the last byte has been read or written to the socket.
boolean	getPassedHandshake() Gets if this socket has completed the BitTorrent handshake
String	getSocketName() Gets the class simple name of the underlying socket.
int	getUploadRate() Returns the last polled upload rate.
boolean	hasOutboundMessages() Checks if this socket has messages queued for sending
void	pollRates() Polls all the transfer speeds.
BitTorrentHandshake	readHandshake() Reads the handshake information from the peer
IMessage	readMessage()
void	sendHandshake(byte[] extensionBytes, byte[] peerId, byte[] torrentHash) Writes the handshake onto the output stream
void	sendMessage() Sends at most 1 pending message.
void	setPassedHandshake() Marks that this socket has passed the BitTorrent handshake and therefor is a valid BitTorrent socket.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BitTorrentSocket

public BitTorrentSocket(MessageFactory messageFactory)

Creates a new unbound BitTorrent socket.

Parameters:

messageFactory - The factory to create IMessage instances.

BitTorrentSocket

public BitTorrentSocket(MessageFactory messageFactory,
                        ISocket socket)
                 throws IOException

Creates a new bound BitTorrent socket.

Parameters:

messageFactory - The factory to create IMessage instances.

socket - The bound socket.

Throws:

IOException - When the IO streams can not be wrapped.

Method Detail

connect

public void connect(ConnectionDegradation degradation,
                    InetSocketAddress address)
             throws IOException

Attempts to connect to the given endpoint in a blocking manner.

Parameters:

degradation - The socket degradation order.

address - The address to connect to

Throws:

IOException - When an IO error occur during the establishing of a connection.

enqueueMessage

public void enqueueMessage(IMessage message)

Queues the message to be send

Parameters:

message - The message to be added to the queue

readMessage

public IMessage readMessage()

sendMessage

public void sendMessage()
                 throws IOException

Sends at most 1 pending message. MessageBlock will be send last

Throws:

IOException

sendHandshake

public void sendHandshake(byte[] extensionBytes,
                          byte[] peerId,
                          byte[] torrentHash)
                   throws IOException

Writes the handshake onto the output stream

Parameters:

extensionBytes - The bytes indicating which extensions we support

peerId - The peer ID which this peer will send out.

torrentHash - The hash of the torrent on which we wish to interact on with this peer.

Throws:

IOException

readHandshake

public BitTorrentHandshake readHandshake()
                                  throws IOException

Reads the handshake information from the peer

Returns:

A successfully read handshake

Throws:

IOException - when either an io error occurs, a protocol error occurs or the peer doesn't respond within 5 seconds.

pollRates

public void pollRates()

Polls all the transfer speeds.

close

public void close()

Closes the connection with the socket

canReadMessage

public boolean canReadMessage()
                       throws IOException

Buffers the next message for reading.

Returns:

Returns true when enough data is buffered to read the next message without blocking.

Throws:

IOException - When an IO error occurs during the buffering.

getDownloadRate

public int getDownloadRate()

Returns the last polled download rate.

Returns:

The amount of downloaded bytes

See Also:

pollRates()

getUploadRate

public int getUploadRate()

Returns the last polled upload rate.

Returns:

The amount of uploaded bytes

See Also:

pollRates()

closed

public boolean closed()

Checks if the socket is closed

Returns:

true if the underlying socket is closed, otherwise false

getPassedHandshake

public boolean getPassedHandshake()

Gets if this socket has completed the BitTorrent handshake

Returns:

true if the handshake was completed

setPassedHandshake

public void setPassedHandshake()

Marks that this socket has passed the BitTorrent handshake and therefor is a valid BitTorrent socket.

hasOutboundMessages

public boolean hasOutboundMessages()

Checks if this socket has messages queued for sending

Returns:

true if there is at least one IMessage waiting to be sent.

getSocketName

public String getSocketName()

Gets the class simple name of the underlying socket.

Returns:

The name of the socket or an empty string when no socket is set.

toString

public String toString()

Overrides:

toString in class Object

getLastActivity

public LocalDateTime getLastActivity()

Gets the time at which the last byte has been read or written to the socket.

Returns:

The most recent activity time