com.thomsonreuters.upa.valueadd.common

Class SelectableBiDirectionalQueue

java.lang.Object

com.thomsonreuters.upa.valueadd.common.SelectableBiDirectionalQueue

public class SelectableBiDirectionalQueue
extends java.lang.Object

A selectable bidirectional queue used to communicate events between the Reactor and Worker threads. To be useful this queue needs a local and remote end. Initially this class operates on the local end of the queues. To operate on the remote end of the queues, call remote().

Constructor Summary

Constructors

Constructor and Description
SelectableBiDirectionalQueue() Normal constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isShutDown() Returns whether or not the queue is shutdown.
VaNode	read() Reads a ReactorEvent sent from the remote end of the queue.
java.nio.channels.SelectableChannel	readChannel() Returns the SelectableChannel of the queue that can be registered with a selector.
int	readQueueSize() Returns the size of the read queue.
SelectableBiDirectionalQueue	remote() Helper method which will create a new SelectableBiDirectionalQueue that uses the remote end of this queue.
void	shutdown() Shuts down the selectable bidirectional queue.
boolean	write(VaNode node) Writes a ReactorEvent to the remote end of the queue.
int	writeQueueSize() Returns the size of the write queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectableBiDirectionalQueue

public SelectableBiDirectionalQueue()

Normal constructor.

Method Detail

isShutDown

public boolean isShutDown()

Returns whether or not the queue is shutdown.

Returns:

true if the queue is shutdown, or false if it isn't

readChannel

public java.nio.channels.SelectableChannel readChannel()

Returns the SelectableChannel of the queue that can be registered with a selector.

Returns:

SelectableChannel of the queue

readQueueSize

public int readQueueSize()

Returns the size of the read queue.

Returns:

the size of the read queue

writeQueueSize

public int writeQueueSize()

Returns the size of the write queue.

Returns:

the size of the write queue

read

public VaNode read()

Reads a ReactorEvent sent from the remote end of the queue. Once the selector fires for the key (registered on readChannel() ), read should be called until it returns null or readQueueSize() is zero. This will reset the internal notifier and allow the selector to fire again later.

Returns:

ReactorEvent

write

public boolean write(VaNode node)

Writes a ReactorEvent to the remote end of the queue.

Parameters:

node - ReactorEvent to write to remote end of queue

Returns:

true if write succeeded, false otherwise

remote

public SelectableBiDirectionalQueue remote()

Helper method which will create a new SelectableBiDirectionalQueue that uses the remote end of this queue. Repeated calls will return the same object, since there is only one remote end of this queue. The user can obtain the same result by calling the SelectableBiDirectionalQueue(SelectableBiDirectionalQueue) constructor.

Returns:

a SelectableBiDirectionalQueue that uses the remote end of this queue

shutdown

public void shutdown()

Shuts down the selectable bidirectional queue.