bt.protocol

Class StandardBittorrentProtocol

java.lang.Object

bt.protocol.StandardBittorrentProtocol

All Implemented Interfaces:

MessageHandler<Message>, Protocol<Message>

public class StandardBittorrentProtocol
extends Object
implements MessageHandler<Message>

Field Summary

Fields

Modifier and Type	Field and Description
static int	BITFIELD_ID
static int	CANCEL_ID
static int	CHOKE_ID
static int	HAVE_ID
static int	INTERESTED_ID
static int	MESSAGE_LENGTH_PREFIX_SIZE BitTorrent message prefix size in bytes.
static int	MESSAGE_PREFIX_SIZE BitTorrent message prefix size in bytes.
static int	MESSAGE_TYPE_SIZE BitTorrent message ID size in bytes.
static int	NOT_INTERESTED_ID
static int	PIECE_ID
static int	REQUEST_ID
static int	UNCHOKE_ID

Constructor Summary

Constructors

Constructor and Description
StandardBittorrentProtocol(Map<Integer,MessageHandler<?>> extraHandlers)

Method Summary

Modifier and Type	Method and Description
int	decode(DecodingContext context, ByteBufferView buffer) Tries to decode message from the byte buffer.
boolean	encode(EncodingContext context, Message message, ByteBuffer buffer) Tries to encode the provided message and place the result into the byte buffer.
Collection<Class<? extends Message>>	getSupportedTypes()
Class<? extends Message>	readMessageType(ByteBufferView buffer) Tries to determine the message type based on the (part of the) message available in the byte buffer.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_LENGTH_PREFIX_SIZE

public static final int MESSAGE_LENGTH_PREFIX_SIZE

BitTorrent message prefix size in bytes.

Since:

1.0

See Also:

Constant Field Values

MESSAGE_TYPE_SIZE

public static final int MESSAGE_TYPE_SIZE

BitTorrent message ID size in bytes.

Since:

1.0

See Also:

Constant Field Values

MESSAGE_PREFIX_SIZE

public static final int MESSAGE_PREFIX_SIZE

BitTorrent message prefix size in bytes. Message prefix is a concatenation of message length prefix and message ID.

Since:

1.0

See Also:

Constant Field Values

CHOKE_ID

public static final int CHOKE_ID

Since:

1.0

See Also:

Constant Field Values

UNCHOKE_ID

public static final int UNCHOKE_ID

Since:

1.0

See Also:

Constant Field Values

INTERESTED_ID

public static final int INTERESTED_ID

Since:

1.0

See Also:

Constant Field Values

NOT_INTERESTED_ID

public static final int NOT_INTERESTED_ID

Since:

1.0

See Also:

Constant Field Values

HAVE_ID

public static final int HAVE_ID

Since:

1.0

See Also:

Constant Field Values

BITFIELD_ID

public static final int BITFIELD_ID

Since:

1.0

See Also:

Constant Field Values

REQUEST_ID

public static final int REQUEST_ID

Since:

1.0

See Also:

Constant Field Values

PIECE_ID

public static final int PIECE_ID

Since:

1.0

See Also:

Constant Field Values

CANCEL_ID

public static final int CANCEL_ID

Since:

1.0

See Also:

Constant Field Values

Constructor Detail

StandardBittorrentProtocol

@Inject
public StandardBittorrentProtocol(Map<Integer,MessageHandler<?>> extraHandlers)

Method Detail

getSupportedTypes

public Collection<Class<? extends Message>> getSupportedTypes()

Specified by:

getSupportedTypes in interface Protocol<Message>

Returns:

All message types, supported by this protocol.

readMessageType

public final Class<? extends Message> readMessageType(ByteBufferView buffer)

Description copied from interface: Protocol

Tries to determine the message type based on the (part of the) message available in the byte buffer.

Specified by:

readMessageType in interface Protocol<Message>

Parameters:

buffer - Byte buffer of arbitrary length containing (a part of) the message. Decoding should be performed starting with the current position of the buffer.

Returns:

Message type or @{code null} if the data is insufficient

decode

public final int decode(DecodingContext context,
                        ByteBufferView buffer)

Description copied from interface: MessageHandler

Tries to decode message from the byte buffer. If decoding is successful, then the result is set into the message context

Specified by:

decode in interface MessageHandler<Message>

Parameters:

context - Message context. In case of success the decoded message must be put into this context.

buffer - Byte buffer of arbitrary length containing (a part of) the message. Decoding should be performed starting with the current position of the buffer.

Returns:

Number of bytes consumed (0 if the provided data is insufficient)

encode

public final boolean encode(EncodingContext context,
                            Message message,
                            ByteBuffer buffer)

Description copied from interface: MessageHandler

Tries to encode the provided message and place the result into the byte buffer.

Specified by:

encode in interface MessageHandler<Message>

Parameters:

context - Encoding context

buffer - Byte buffer of arbitrary capacity. Encoded message should be placed into the buffer starting with its current position. Protocol should check if the buffer has sufficient space available, and return false if it's not the case.

Returns:

true if message has been successfully encoded and fully written into the provided buffer