bt.protocol.extended

Class ExtendedProtocol

java.lang.Object

bt.protocol.handler.BaseMessageHandler<ExtendedMessage>

bt.protocol.extended.ExtendedProtocol

All Implemented Interfaces:

MessageHandler<ExtendedMessage>, Protocol<ExtendedMessage>

public class ExtendedProtocol
extends BaseMessageHandler<ExtendedMessage>

Built-in support for extensions protocols.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXTENDED_MESSAGE_ID Unique message type ID for all extended message types.

Constructor Summary

Constructors

Constructor and Description
ExtendedProtocol(ExtendedMessageTypeMapping messageTypeMapping, Map<String,MessageHandler<? extends ExtendedMessage>> handlersByTypeName)

Method Summary

Modifier and Type	Method and Description
int	doDecode(DecodingContext context, ByteBufferView buffer) Decode the payload of a message (excluding message prefix -- see StandardBittorrentProtocol.MESSAGE_PREFIX_SIZE) and place it into the provided context.
boolean	doEncode(EncodingContext context, ExtendedMessage message, ByteBuffer buffer) Encode the payload of a message (excluding message prefix -- see StandardBittorrentProtocol.MESSAGE_PREFIX_SIZE) and write it into the provided buffer.
Collection<Class<? extends ExtendedMessage>>	getSupportedTypes()
Class<? extends ExtendedMessage>	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 bt.protocol.handler.BaseMessageHandler

decode, encode

Methods inherited from class java.lang.Object

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

Field Detail

EXTENDED_MESSAGE_ID

public static final int EXTENDED_MESSAGE_ID

Unique message type ID for all extended message types. It must be present in the encoded representation of the message in order for it to be passed to the ExtendedProtocol for further processing.

Since:

1.0

See Also:

Constant Field Values

Constructor Detail

ExtendedProtocol

@Inject
public ExtendedProtocol(ExtendedMessageTypeMapping messageTypeMapping,
                                Map<String,MessageHandler<? extends ExtendedMessage>> handlersByTypeName)

Method Detail

getSupportedTypes

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

Returns:

All message types, supported by this protocol.

readMessageType

public Class<? extends ExtendedMessage> 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.

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

doDecode

public int doDecode(DecodingContext context,
                    ByteBufferView buffer)

Description copied from class: BaseMessageHandler

Decode the payload of a message (excluding message prefix -- see StandardBittorrentProtocol.MESSAGE_PREFIX_SIZE) and place it into the provided context.

Specified by:

doDecode in class BaseMessageHandler<ExtendedMessage>

Parameters:

context - The context to place the decoded message into.

buffer - Buffer to decode from. Buffer.remaining() is set to the declared length of the message. Message payload starts precisely at buffer's Buffer.position().

doEncode

public boolean doEncode(EncodingContext context,
                        ExtendedMessage message,
                        ByteBuffer buffer)

Description copied from class: BaseMessageHandler

Encode the payload of a message (excluding message prefix -- see StandardBittorrentProtocol.MESSAGE_PREFIX_SIZE) and write it into the provided buffer.

Specified by:

doEncode in class BaseMessageHandler<ExtendedMessage>

Parameters:

context - Encoding context

buffer - Byte buffer to write to. Encoded message should be placed into the buffer starting with its current position. This method should check if the buffer has sufficient space available, and return false if it's not the case. After this method returns, the buffer's Buffer.position() is used to calculate the size of message's payload, which is then specified in the message's prefix.

Returns:

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