Package org.ros.internal.transport.queue

Class MessageDispatcher<T>

java.lang.Object

org.ros.concurrent.CancellableLoop

org.ros.internal.transport.queue.MessageDispatcher<T>

Type Parameters:

T - the message type

All Implemented Interfaces:

Runnable

public class MessageDispatcher<T>
extends CancellableLoop

Author:

damonkohler@google.com (Damon Kohler)

Constructor Summary

Constructors

Constructor	Description
MessageDispatcher(CircularBlockingDeque<LazyMessage<T>> lazyMessages, ExecutorService executorService)

Method Summary

Modifier and Type	Method	Description
void	addListener(org.ros.message.MessageListener<T> messageListener, int limit)	Adds the specified MessageListener to the internal ListenerGroup.
boolean	getLatchMode()
protected void	handleInterruptedException(InterruptedException e)	An InterruptedException was thrown.
void	loop()	The body of the loop.
void	removeAllListeners()	Removes all the registered MessageListeners.
boolean	removeListener(org.ros.message.MessageListener<T> messageListener)	Removes the specified MessageListener from the internal ListenerGroup.
void	setLatchMode(boolean enabled)

Methods inherited from class org.ros.concurrent.CancellableLoop

cancel, isRunning, run, setup

Methods inherited from class java.lang.Object

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

Constructor Details

MessageDispatcher

public MessageDispatcher(CircularBlockingDeque<LazyMessage<T>> lazyMessages,
 ExecutorService executorService)

Method Details

addListener

public void addListener(org.ros.message.MessageListener<T> messageListener,
 int limit)

Adds the specified MessageListener to the internal ListenerGroup. If latchMode is true, the latchedMessage will be immediately dispatched to the specified MessageListener.

See Also:

• ListenerGroup.add(Object, int)

removeListener

public boolean removeListener(org.ros.message.MessageListener<T> messageListener)

Removes the specified MessageListener from the internal ListenerGroup.

Parameters:

messageListener - MessageListener to remove.

Returns:

True if the listener was removed, false if it wasn't registered before.

See Also:

• ListenerGroup.remove(Object)

removeAllListeners

public void removeAllListeners()

Removes all the registered MessageListeners.

See Also:

• ListenerGroup.shutdown()

setLatchMode

public void setLatchMode(boolean enabled)

Parameters:

enabled - true if latch mode should be enabled, false otherwise

getLatchMode

public boolean getLatchMode()

Returns:

true if latch mode is enabled, false otherwise

loop

public void loop()
          throws InterruptedException

Description copied from class: CancellableLoop

The body of the loop. This will run continuously until the CancellableLoop has been interrupted externally or by calling CancellableLoop.cancel().

Specified by:

loop in class CancellableLoop

Throws:

InterruptedException

handleInterruptedException

protected void handleInterruptedException(InterruptedException e)

Description copied from class: CancellableLoop

An InterruptedException was thrown.

Overrides:

handleInterruptedException in class CancellableLoop