Class IncomingMessageQueueImpl

java.lang.Object

com.biglybt.core.networkmanager.impl.IncomingMessageQueueImpl

All Implemented Interfaces:

IncomingMessageQueue

public class IncomingMessageQueueImpl
extends Object
implements IncomingMessageQueue

Inbound peer message queue.

Nested Class Summary

Nested classes/interfaces inherited from interface IncomingMessageQueue

IncomingMessageQueue.MessageQueueListener

Field Summary

Fields

Modifier and Type	Field	Description
private final NetworkConnection	connection
private ArrayList<IncomingMessageQueue.MessageQueueListener>	listeners
private final AEMonitor	listeners_mon
private MessageStreamDecoder	stream_decoder

Constructor Summary

Constructors

Constructor	Description
IncomingMessageQueueImpl(MessageStreamDecoder stream_decoder, NetworkConnection connection)	Create a new incoming message queue.

Method Summary

Modifier and Type	Method	Description
void	cancelQueueListener(IncomingMessageQueue.MessageQueueListener listener)	Cancel queue event notification listener.
void	destroy()	Destroy this queue.
int[]	getCurrentMessageProgress()	Get the progress of the current message that is being received
MessageStreamDecoder	getDecoder()
void	notifyOfExternallyReceivedMessage(Message message)	Notifty the queue (and its listeners) of a message received externally on the queue's behalf.
long[]	receiveFromTransport(long max_bytes, boolean protocol_is_free)	Receive (read) message(s) data from the underlying transport.
void	registerQueueListener(IncomingMessageQueue.MessageQueueListener listener)	Add a listener to be notified of queue events.
void	resumeQueueProcessing()	Manually resume processing (reading) incoming messages.
void	setDecoder(MessageStreamDecoder new_stream_decoder)	Set the message stream decoder that will be used to decode incoming messages.

Methods inherited from class Object

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

Field Details

listeners

private volatile ArrayList<IncomingMessageQueue.MessageQueueListener> listeners

listeners_mon

private final AEMonitor listeners_mon

stream_decoder

private MessageStreamDecoder stream_decoder

connection

private final NetworkConnection connection

Constructor Details

IncomingMessageQueueImpl

public IncomingMessageQueueImpl(MessageStreamDecoder stream_decoder,
 NetworkConnection connection)

Create a new incoming message queue.

Parameters:

stream_decoder - default message stream decoder

connection - owner to read from

Method Details

setDecoder

public void setDecoder(MessageStreamDecoder new_stream_decoder)

Set the message stream decoder that will be used to decode incoming messages.

Specified by:

setDecoder in interface IncomingMessageQueue

Parameters:

new_stream_decoder - to use

getDecoder

public MessageStreamDecoder getDecoder()

Specified by:

getDecoder in interface IncomingMessageQueue

getCurrentMessageProgress

public int[] getCurrentMessageProgress()

Description copied from interface: IncomingMessageQueue

Get the progress of the current message that is being received

Specified by:

getCurrentMessageProgress in interface IncomingMessageQueue

Returns:

[size, done] or null

receiveFromTransport

public long[] receiveFromTransport(long max_bytes,
 boolean protocol_is_free)
                            throws IOException

Receive (read) message(s) data from the underlying transport.

Specified by:

receiveFromTransport in interface IncomingMessageQueue

Parameters:

max_bytes - to read

Returns:

number of bytes received

Throws:

IOException - on receive error

notifyOfExternallyReceivedMessage

public void notifyOfExternallyReceivedMessage(Message message)
                                       throws IOException

Notifty the queue (and its listeners) of a message received externally on the queue's behalf.

Specified by:

notifyOfExternallyReceivedMessage in interface IncomingMessageQueue

Parameters:

message - received externally

Throws:

IOException

resumeQueueProcessing

public void resumeQueueProcessing()

Manually resume processing (reading) incoming messages. NOTE: Allows us to resume docoding externally, in case it was auto-paused internally.

Specified by:

resumeQueueProcessing in interface IncomingMessageQueue

registerQueueListener

public void registerQueueListener(IncomingMessageQueue.MessageQueueListener listener)

Add a listener to be notified of queue events.

Specified by:

registerQueueListener in interface IncomingMessageQueue

Parameters:

listener -

cancelQueueListener

public void cancelQueueListener(IncomingMessageQueue.MessageQueueListener listener)

Cancel queue event notification listener.

Specified by:

cancelQueueListener in interface IncomingMessageQueue

Parameters:

listener -

destroy

public void destroy()

Destroy this queue.

Specified by:

destroy in interface IncomingMessageQueue