org.ros.concurrent

Class ListenerGroup<T>

java.lang.Object

org.ros.concurrent.ListenerGroup<T>

public class ListenerGroup<T>
extends java.lang.Object

A group of listeners.

Constructor Summary

Constructors

Constructor and Description
ListenerGroup(java.util.concurrent.ExecutorService executorService)

Method Summary

Methods

Modifier and Type	Method and Description
EventDispatcher<T>	add(T listener) Adds the specified listener to the ListenerGroup with the queue limit set to DEFAULT_QUEUE_CAPACITY.
EventDispatcher<T>	add(T listener, int queueCapacity) Adds a listener to the ListenerGroup.
java.util.Collection<EventDispatcher<T>>	addAll(java.util.Collection<T> listeners) Adds all the specified listeners to the ListenerGroup with the queue capacity for each set to Integer.MAX_VALUE.
java.util.Collection<EventDispatcher<T>>	addAll(java.util.Collection<T> listeners, int limit) Adds all the specified listeners to the ListenerGroup.
void	shutdown()
void	signal(SignalRunnable<T> signalRunnable) Signals all listeners.
boolean	signal(SignalRunnable<T> signalRunnable, long timeout, java.util.concurrent.TimeUnit unit) Signals all listeners and waits for the result.
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

ListenerGroup

public ListenerGroup(java.util.concurrent.ExecutorService executorService)

Method Detail

add

public EventDispatcher<T> add(T listener,
                     int queueCapacity)

Adds a listener to the ListenerGroup.

Parameters:

listener - the listener to add

queueCapacity - the maximum number of events to buffer

Returns:

the EventDispatcher responsible for calling the specified listener

add

public EventDispatcher<T> add(T listener)

Adds the specified listener to the ListenerGroup with the queue limit set to DEFAULT_QUEUE_CAPACITY.

Parameters:

listener - the listener to add

Returns:

the EventDispatcher responsible for calling the specified listener

addAll

public java.util.Collection<EventDispatcher<T>> addAll(java.util.Collection<T> listeners,
                                              int limit)

Adds all the specified listeners to the ListenerGroup.

Parameters:

listeners - the listeners to add

limit - the maximum number of events to buffer

Returns:

a Collection of EventDispatchers responsible for calling the specified listeners

addAll

public java.util.Collection<EventDispatcher<T>> addAll(java.util.Collection<T> listeners)

Adds all the specified listeners to the ListenerGroup with the queue capacity for each set to Integer.MAX_VALUE.

Parameters:

listeners - the listeners to add

Returns:

a Collection of EventDispatchers responsible for calling the specified listeners

size

public int size()

Returns:

the number of listeners in the group

signal

public void signal(SignalRunnable<T> signalRunnable)

Signals all listeners.

Each SignalRunnable is executed in a separate thread.

signal

public boolean signal(SignalRunnable<T> signalRunnable,
             long timeout,
             java.util.concurrent.TimeUnit unit)
               throws java.lang.InterruptedException

Signals all listeners and waits for the result.

Each SignalRunnable is executed in a separate thread. In the event that the SignalRunnable is be dropped from the EventDispatcher's queue and thus not executed, this method will block for the entire specified timeout.

Returns:

true if all listeners completed within the specified time limit, false otherwise

Throws:

java.lang.InterruptedException

shutdown

public void shutdown()