Class PeerForeignNetworkConnection.imq

java.lang.Object

com.biglybt.pifimpl.local.peers.PeerForeignNetworkConnection.imq

All Implemented Interfaces:

IncomingMessageQueue

Enclosing class:

PeerForeignNetworkConnection

protected class PeerForeignNetworkConnection.imq
extends Object
implements IncomingMessageQueue

Nested Class Summary

Nested classes/interfaces inherited from interface IncomingMessageQueue

IncomingMessageQueue.MessageQueueListener

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	imq()

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

Constructor Details

imq

protected imq()

Method Details

setDecoder

public void setDecoder(MessageStreamDecoder new_stream_decoder)

Description copied from interface: IncomingMessageQueue

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

Description copied from interface: IncomingMessageQueue

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 as [data, protocol]

Throws:

IOException - on receive error

notifyOfExternallyReceivedMessage

public void notifyOfExternallyReceivedMessage(Message message)

Description copied from interface: IncomingMessageQueue

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

resumeQueueProcessing

public void resumeQueueProcessing()

Description copied from interface: IncomingMessageQueue

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)

Description copied from interface: IncomingMessageQueue

Add a listener to be notified of queue events.

Specified by:

registerQueueListener in interface IncomingMessageQueue

Parameters:

listener -

cancelQueueListener

public void cancelQueueListener(IncomingMessageQueue.MessageQueueListener listener)

Description copied from interface: IncomingMessageQueue

Cancel queue event notification listener.

Specified by:

cancelQueueListener in interface IncomingMessageQueue

Parameters:

listener -

destroy

public void destroy()

Description copied from interface: IncomingMessageQueue

Destroy this queue.

Specified by:

destroy in interface IncomingMessageQueue