org.ros.internal.transport.queue.OutgoingMessageQueue< T > Class Reference

List of all members.

Classes
class	Writer
Public Member Functions
void	add (T message)
void	addChannel (Channel channel)
ChannelGroup	getChannelGroup ()
boolean	getLatchMode ()
int	getNumberOfChannels ()
	OutgoingMessageQueue (MessageSerializer< T > serializer, ExecutorService executorService)
void	setLatchMode (boolean enabled)
void	shutdown ()
Private Member Functions
void	setLatchedMessage (T message)
void	writeLatchedMessage (Channel channel)
Private Attributes
final ChannelGroup	channelGroup
final CircularBlockingDeque< T >	deque
final ChannelBuffer	latchedBuffer
T	latchedMessage
boolean	latchMode
final MessageBufferPool	messageBufferPool
final Object	mutex
final MessageSerializer< T >	serializer
final Writer	writer
Static Private Attributes
static final boolean	DEBUG = false
static final int	DEQUE_CAPACITY = 16
static final Log	log = LogFactory.getLog(OutgoingMessageQueue.class)

---

Detailed Description

Author:

damonkohler@google.com (Damon Kohler)

Definition at line 40 of file OutgoingMessageQueue.java.

---

Constructor & Destructor Documentation

org.ros.internal.transport.queue.OutgoingMessageQueue< T >.OutgoingMessageQueue	(	MessageSerializer< T >	serializer,
		ExecutorService	executorService
	)		[inline]

Definition at line 81 of file OutgoingMessageQueue.java.

---

Member Function Documentation

void org.ros.internal.transport.queue.OutgoingMessageQueue< T >.add

(

T

message

)

[inline]

Parameters:

message

the message to add to the queue

Definition at line 105 of file OutgoingMessageQueue.java.

void org.ros.internal.transport.queue.OutgoingMessageQueue< T >.addChannel

(

Channel

channel

)

[inline]

Parameters:

channel

added to this OutgoingMessageQueue's ChannelGroup

Definition at line 128 of file OutgoingMessageQueue.java.

ChannelGroup org.ros.internal.transport.queue.OutgoingMessageQueue< T >.getChannelGroup

(

)

[inline]

Definition at line 157 of file OutgoingMessageQueue.java.

boolean org.ros.internal.transport.queue.OutgoingMessageQueue< T >.getLatchMode

(

)

[inline]

Definition at line 97 of file OutgoingMessageQueue.java.

int org.ros.internal.transport.queue.OutgoingMessageQueue< T >.getNumberOfChannels

(

)

[inline]

Returns:

the number of Channels which have been added to this queue

Definition at line 152 of file OutgoingMessageQueue.java.

void org.ros.internal.transport.queue.OutgoingMessageQueue< T >.setLatchedMessage

(

T

message

)

[inline, private]

Definition at line 110 of file OutgoingMessageQueue.java.

void org.ros.internal.transport.queue.OutgoingMessageQueue< T >.setLatchMode

(

boolean

enabled

)

[inline]

Definition at line 93 of file OutgoingMessageQueue.java.

void org.ros.internal.transport.queue.OutgoingMessageQueue< T >.shutdown

(

)

[inline]

Stop writing messages and close all outgoing connections.

Definition at line 119 of file OutgoingMessageQueue.java.

void org.ros.internal.transport.queue.OutgoingMessageQueue< T >.writeLatchedMessage

(

Channel

channel

)

[inline, private]

Definition at line 141 of file OutgoingMessageQueue.java.

---

Member Data Documentation

final ChannelGroup org.ros.internal.transport.queue.OutgoingMessageQueue< T >.channelGroup [private]

Definition at line 49 of file OutgoingMessageQueue.java.

final boolean org.ros.internal.transport.queue.OutgoingMessageQueue< T >.DEBUG = false [static, private]

Definition at line 42 of file OutgoingMessageQueue.java.

final CircularBlockingDeque<T> org.ros.internal.transport.queue.OutgoingMessageQueue< T >.deque [private]

Definition at line 48 of file OutgoingMessageQueue.java.

final int org.ros.internal.transport.queue.OutgoingMessageQueue< T >.DEQUE_CAPACITY = 16 [static, private]

Definition at line 45 of file OutgoingMessageQueue.java.

final ChannelBuffer org.ros.internal.transport.queue.OutgoingMessageQueue< T >.latchedBuffer [private]

Definition at line 52 of file OutgoingMessageQueue.java.

T org.ros.internal.transport.queue.OutgoingMessageQueue< T >.latchedMessage [private]

Definition at line 56 of file OutgoingMessageQueue.java.

boolean org.ros.internal.transport.queue.OutgoingMessageQueue< T >.latchMode [private]

Definition at line 55 of file OutgoingMessageQueue.java.

final Log org.ros.internal.transport.queue.OutgoingMessageQueue< T >.log = LogFactory.getLog(OutgoingMessageQueue.class) [static, private]

Definition at line 43 of file OutgoingMessageQueue.java.

final MessageBufferPool org.ros.internal.transport.queue.OutgoingMessageQueue< T >.messageBufferPool [private]

Definition at line 51 of file OutgoingMessageQueue.java.

final Object org.ros.internal.transport.queue.OutgoingMessageQueue< T >.mutex [private]

Definition at line 53 of file OutgoingMessageQueue.java.

final MessageSerializer<T> org.ros.internal.transport.queue.OutgoingMessageQueue< T >.serializer [private]

Definition at line 47 of file OutgoingMessageQueue.java.

final Writer org.ros.internal.transport.queue.OutgoingMessageQueue< T >.writer [private]

Definition at line 50 of file OutgoingMessageQueue.java.

---

The documentation for this class was generated from the following file:

• OutgoingMessageQueue.java