org.ros.node.topic.CountDownSubscriberListener< T > Class Reference

Inheritance diagram for org.ros.node.topic.CountDownSubscriberListener< T >:

List of all members.

Public Member Functions
void	awaitNewPublisher () throws InterruptedException
boolean	awaitNewPublisher (long timeout, TimeUnit unit) throws InterruptedException
void	awaitShutdown () throws InterruptedException
boolean	awaitShutdown (long timeout, TimeUnit unit) throws InterruptedException
void	onNewPublisher (Subscriber< T > subscriber, PublisherIdentifier publisherIdentifier)
void	onShutdown (Subscriber< T > subscriber)
Static Public Member Functions
static< T > CountDownSubscriberListener < T >	newDefault ()
static< T > CountDownSubscriberListener < T >	newFromCounts (int masterRegistrationSuccessCount, int masterRegistrationFailureCount, int masterUnregistrationSuccessCount, int masterUnregistrationFailureCount, int newSubscriberCount)
Private Member Functions
	CountDownSubscriberListener (CountDownLatch masterRegistrationSuccessLatch, CountDownLatch masterRegistrationFailureLatch, CountDownLatch masterUnregistrationSuccessLatch, CountDownLatch masterUnregistrationFailureLatch, CountDownLatch newPublisherLatch)
Private Attributes
final CountDownLatch	newPublisherLatch
final CountDownLatch	shutdownLatch

---

Detailed Description

A SubscriberListener which uses separate CountDownLatch instances for all messages.

Author:

khughes@google.com (Keith M. Hughes)

Definition at line 32 of file CountDownSubscriberListener.java.

---

Constructor & Destructor Documentation

org.ros.node.topic.CountDownSubscriberListener< T >.CountDownSubscriberListener	(	CountDownLatch	masterRegistrationSuccessLatch,
		CountDownLatch	masterRegistrationFailureLatch,
		CountDownLatch	masterUnregistrationSuccessLatch,
		CountDownLatch	masterUnregistrationFailureLatch,
		CountDownLatch	newPublisherLatch
	)		[inline, private]

Definition at line 68 of file CountDownSubscriberListener.java.

---

Member Function Documentation

void org.ros.node.topic.CountDownSubscriberListener< T >.awaitNewPublisher

(

)

throws InterruptedException [inline]

Wait for the requested number of new publishers.

Exceptions:

InterruptedException

Definition at line 93 of file CountDownSubscriberListener.java.

boolean org.ros.node.topic.CountDownSubscriberListener< T >.awaitNewPublisher	(	long	timeout,
		TimeUnit	unit
	)		throws InterruptedException [inline]

Wait for the requested number of new publishers within the given time period.

Parameters:

timeout	the maximum time to wait
unit	the time unit of the timeout argument

Returns:

 true 

if the new publishers connected within the time period,

 false 

otherwise

Exceptions:

InterruptedException

Definition at line 109 of file CountDownSubscriberListener.java.

void org.ros.node.topic.CountDownSubscriberListener< T >.awaitShutdown

(

)

throws InterruptedException [inline]

Wait for shutdown.

Exceptions:

InterruptedException

Definition at line 118 of file CountDownSubscriberListener.java.

boolean org.ros.node.topic.CountDownSubscriberListener< T >.awaitShutdown	(	long	timeout,
		TimeUnit	unit
	)		throws InterruptedException [inline]

Wait for shutdown within the given time period.

Parameters:

timeout	the maximum time to wait
unit	the time unit of the timeout argument

Returns:

 true 

if the shutdowns happened within the time period,

 false 

otherwise

Exceptions:

InterruptedException

Definition at line 133 of file CountDownSubscriberListener.java.

static <T> CountDownSubscriberListener<T> org.ros.node.topic.CountDownSubscriberListener< T >.newDefault

(

)

[inline, static]

Construct a CountDownSubscriberListener with all counts set to 1.

Definition at line 41 of file CountDownSubscriberListener.java.

static <T> CountDownSubscriberListener<T> org.ros.node.topic.CountDownSubscriberListener< T >.newFromCounts	(	int	masterRegistrationSuccessCount,
		int	masterRegistrationFailureCount,
		int	masterUnregistrationSuccessCount,
		int	masterUnregistrationFailureCount,
		int	newSubscriberCount
	)		[inline, static]

Parameters:

masterRegistrationSuccessCount	the number of successful master registrations to wait for
masterRegistrationFailureCount	the number of failing master registrations to wait for
masterUnregistrationSuccessCount	the number of successful master unregistrations to wait for
masterUnregistrationFailureCount	the number of failing master unregistrations to wait for
newSubscriberCount	the number of counts to wait for for a new publisher

Definition at line 57 of file CountDownSubscriberListener.java.

void org.ros.node.topic.CountDownSubscriberListener< T >.onNewPublisher	(	Subscriber< T >	subscriber,
		PublisherIdentifier	publisherIdentifier
	)		[inline]

A new Publisher has connected to the Subscriber.

Parameters:

subscriber	the Subscriber that the Publisher connected to
publisherIdentifier	the PublisherIdentifier of the new Publisher

Implements org.ros.node.topic.SubscriberListener< T >.

Definition at line 79 of file CountDownSubscriberListener.java.

void org.ros.node.topic.CountDownSubscriberListener< T >.onShutdown

(

Subscriber< T >

subscriber

)

[inline]

The Subscriber has been shut down.

Parameters:

subscriber

the Subscriber that was shut down

Implements org.ros.node.topic.SubscriberListener< T >.

Definition at line 84 of file CountDownSubscriberListener.java.

---

Member Data Documentation

final CountDownLatch org.ros.node.topic.CountDownSubscriberListener< T >.newPublisherLatch [private]

Definition at line 36 of file CountDownSubscriberListener.java.

final CountDownLatch org.ros.node.topic.CountDownSubscriberListener< T >.shutdownLatch [private]

Definition at line 35 of file CountDownSubscriberListener.java.

---

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

• CountDownSubscriberListener.java