Class BTMessageDecoder

java.lang.Object

com.biglybt.core.peermanager.messaging.bittorrent.BTMessageDecoder

All Implemented Interfaces:

MessageStreamDecoder

Direct Known Subclasses:

LTMessageDecoder

public class BTMessageDecoder
extends Object
implements MessageStreamDecoder

Field Summary

Fields

Modifier and Type	Field	Description
private int	data_bytes_last_read
private final ByteBuffer[]	decode_array
private boolean	destroyed
private static final int	HANDSHAKE_FAKE_LENGTH
private boolean	is_paused
private boolean	last_received_was_keepalive
private final DirectByteBuffer	length_buffer
private static final int	MAX_MESSAGE_LENGTH
private int	message_length
private final ArrayList	messages_last_read
private static final int	MIN_MESSAGE_LENGTH
private DirectByteBuffer	payload_buffer
private int	pre_read_start_buffer
private int	pre_read_start_position
private int[]	progress
private int	progress_id
private int	protocol_bytes_last_read
private boolean	reading_handshake_message
private boolean	reading_length_mode
private static final byte	SS

Constructor Summary

Constructors

Constructor	Description
BTMessageDecoder()

Method Summary

Modifier and Type	Method	Description
protected Message	createMessage(DirectByteBuffer ref_buff)
ByteBuffer	destroy()	Destroy this decoder, i.e.
int[]	getCurrentMessageProgress()	Get the details of the current message that is being received (read from the transport).
int	getDataBytesDecoded()	Get the number of (piece) data bytes decoded from the transport, from the last decode op.
int	getProtocolBytesDecoded()	Get the number of protocol (overhead) bytes decoded from the transport, from the last decode op.
void	pauseDecoding()	Pause message decoding.
long	performStreamDecode(Transport transport, long max_bytes)	Decode message stream from the given transport.
private int	postReadProcess()
private long	preReadProcess(long allowed)
Message[]	removeDecodedMessages()	Get the messages decoded from the transport, if any, from the last decode op.
void	resumeDecoding()	Resume message decoding.

Methods inherited from class Object

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

Field Details

MIN_MESSAGE_LENGTH

private static final int MIN_MESSAGE_LENGTH

See Also:

• Constant Field Values

MAX_MESSAGE_LENGTH

private static final int MAX_MESSAGE_LENGTH

See Also:

• Constant Field Values

HANDSHAKE_FAKE_LENGTH

private static final int HANDSHAKE_FAKE_LENGTH

See Also:

• Constant Field Values

SS

private static final byte SS

See Also:

• Constant Field Values

payload_buffer

private DirectByteBuffer payload_buffer

length_buffer

private final DirectByteBuffer length_buffer

decode_array

private final ByteBuffer[] decode_array

reading_length_mode

private boolean reading_length_mode

reading_handshake_message

private boolean reading_handshake_message

message_length

private int message_length

pre_read_start_buffer

private int pre_read_start_buffer

pre_read_start_position

private int pre_read_start_position

last_received_was_keepalive

private boolean last_received_was_keepalive

destroyed

private volatile boolean destroyed

is_paused

private volatile boolean is_paused

messages_last_read

private final ArrayList messages_last_read

protocol_bytes_last_read

private int protocol_bytes_last_read

data_bytes_last_read

private int data_bytes_last_read

progress_id

private int progress_id

progress

private int[] progress

Constructor Details

BTMessageDecoder

public BTMessageDecoder()

Method Details

performStreamDecode

public long performStreamDecode(Transport transport,
 long max_bytes)
                         throws IOException

Description copied from interface: MessageStreamDecoder

Decode message stream from the given transport.

Specified by:

performStreamDecode in interface MessageStreamDecoder

Parameters:

transport - to decode from

max_bytes - to decode/read from the stream

Returns:

number of bytes decoded

Throws:

IOException - on decoding error

getCurrentMessageProgress

public int[] getCurrentMessageProgress()

Description copied from interface: MessageStreamDecoder

Get the details of the current message that is being received (read from the transport).

Specified by:

getCurrentMessageProgress in interface MessageStreamDecoder

Returns:

[ size, done ] or null

removeDecodedMessages

public Message[] removeDecodedMessages()

Description copied from interface: MessageStreamDecoder

Get the messages decoded from the transport, if any, from the last decode op.

Specified by:

removeDecodedMessages in interface MessageStreamDecoder

Returns:

decoded messages, or null if no new complete messages were decoded

getProtocolBytesDecoded

public int getProtocolBytesDecoded()

Description copied from interface: MessageStreamDecoder

Get the number of protocol (overhead) bytes decoded from the transport, from the last decode op.

Specified by:

getProtocolBytesDecoded in interface MessageStreamDecoder

Returns:

number of protocol bytes received

getDataBytesDecoded

public int getDataBytesDecoded()

Description copied from interface: MessageStreamDecoder

Get the number of (piece) data bytes decoded from the transport, from the last decode op.

Specified by:

getDataBytesDecoded in interface MessageStreamDecoder

Returns:

number of data bytes received

destroy

public ByteBuffer destroy()

Description copied from interface: MessageStreamDecoder

Destroy this decoder, i.e. perform cleanup.

Specified by:

destroy in interface MessageStreamDecoder

Returns:

any bytes already-read and still remaining within the decoder

preReadProcess

private long preReadProcess(long allowed)

postReadProcess

private int postReadProcess()
                     throws IOException

Throws:

IOException

pauseDecoding

public void pauseDecoding()

Description copied from interface: MessageStreamDecoder

Pause message decoding.

Specified by:

pauseDecoding in interface MessageStreamDecoder

resumeDecoding

public void resumeDecoding()

Description copied from interface: MessageStreamDecoder

Resume message decoding.

Specified by:

resumeDecoding in interface MessageStreamDecoder

createMessage

protected Message createMessage(DirectByteBuffer ref_buff)
                         throws MessageException

Throws:

MessageException