bt.protocol.handler

Interface MessageHandler<T extends Message>

Type Parameters:

T - Message type or a common supertype of several message types, that this handler is able to encode and decode.

All Superinterfaces:

Protocol<T>

All Known Implementing Classes:

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

public interface MessageHandler<T extends Message>
extends Protocol<T>

Message encoder/decoder.

Since:

1.0

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, T message, ByteBuffer buffer) Tries to encode the provided message and place the result into the byte buffer.

Methods inherited from interface bt.protocol.Protocol

getSupportedTypes, readMessageType

Method Detail

encode

boolean encode(EncodingContext context,
               T message,
               ByteBuffer buffer)

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

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

Throws:

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

Since:

1.3

decode

int decode(DecodingContext context,
           ByteBufferView buffer)

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

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)

Throws:

InvalidMessageException - if data is invalid

Since:

1.0