bt.protocol

Interface Protocol<T>

Type Parameters:

T - Common supertype for all message types, supported by this protocol.

All Known Subinterfaces:

MessageHandler<T>

All Known Implementing Classes:

BaseMessageHandler, BitfieldHandler, CancelHandler, ChokeHandler, ExtendedProtocol, HaveHandler, InterestedHandler, NotInterestedHandler, PieceHandler, PortMessageHandler, RequestHandler, StandardBittorrentProtocol, UnchokeHandler, UniqueMessageHandler, UtMetadataMessageHandler

public interface Protocol<T>

Protocol is responsible for determining message types. When a message is received from peer, the protocol is the first entity in the message processing chain to correctly determine the type of message and delegate the decoding of the message to a particular message handler.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Collection<Class<? extends T>>	getSupportedTypes()
Class<? extends T>	readMessageType(ByteBufferView buffer) Tries to determine the message type based on the (part of the) message available in the byte buffer.

Method Detail

getSupportedTypes

Collection<Class<? extends T>> getSupportedTypes()

Returns:

All message types, supported by this protocol.

Since:

1.0

readMessageType

Class<? extends T> readMessageType(ByteBufferView buffer)

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

Throws:

InvalidMessageException - if prefix is invalid or the message type is not supported

Since:

1.0