Class GenericMessageDecoder

java.lang.Object

com.biglybt.pifimpl.local.messaging.GenericMessageDecoder

All Implemented Interfaces:

MessageStreamDecoder

public class GenericMessageDecoder
extends Object
implements MessageStreamDecoder

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBuffer[]	buffers
private int	data_bytes_last_read
private boolean	destroyed
private final ByteBuffer	length_buffer
static final int	MAX_MESSAGE_LENGTH
private List	messages
private final String	msg_desc
private final String	msg_type
private int	protocol_bytes_last_read

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GenericMessageDecoder(String _msg_type, String _msg_desc)

Method Summary

Modifier and Type	Method	Description
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.
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

MAX_MESSAGE_LENGTH

public static final int MAX_MESSAGE_LENGTH

See Also:

• Constant Field Values

length_buffer

private final ByteBuffer length_buffer

buffers

private final ByteBuffer[] buffers

msg_type

private final String msg_type

msg_desc

private final String msg_desc

messages

private List messages

protocol_bytes_last_read

private int protocol_bytes_last_read

data_bytes_last_read

private int data_bytes_last_read

destroyed

private volatile boolean destroyed

Constructor Details

GenericMessageDecoder

protected GenericMessageDecoder(String _msg_type,
 String _msg_desc)

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

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

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

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

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