Public Member Functions | Private Attributes
org.ros.internal.node.CountDownRegistrantListener< T > Class Reference
Inheritance diagram for org.ros.internal.node.CountDownRegistrantListener< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void awaitMasterRegistrationFailure () throws InterruptedException
boolean awaitMasterRegistrationFailure (long timeout, TimeUnit unit) throws InterruptedException
void awaitMasterRegistrationSuccess () throws InterruptedException
boolean awaitMasterRegistrationSuccess (long timeout, TimeUnit unit) throws InterruptedException
void awaitMasterUnregistrationFailure () throws InterruptedException
boolean awaitMasterUnregistrationFailure (long timeout, TimeUnit unit) throws InterruptedException
void awaitMasterUnregistrationSuccess () throws InterruptedException
boolean awaitMasterUnregistrationSuccess (long timeout, TimeUnit unit) throws InterruptedException
 CountDownRegistrantListener ()
 CountDownRegistrantListener (int masterRegistrationSuccessCount, int masterRegistrationFailureCount, int masterUnregistrationSuccessCount, int masterUnregistrationFailureCount)
 CountDownRegistrantListener (CountDownLatch masterRegistrationSuccessLatch, CountDownLatch masterRegistrationFailureLatch, CountDownLatch masterUnregistrationSuccessLatch, CountDownLatch masterUnregistrationFailureLatch)
void onMasterRegistrationFailure (T registrant)
void onMasterRegistrationSuccess (T registrant)
void onMasterUnregistrationFailure (T registrant)
void onMasterUnregistrationSuccess (T registrant)

Private Attributes

final CountDownLatch masterRegistrationFailureLatch
final CountDownLatch masterRegistrationSuccessLatch
final CountDownLatch masterUnregistrationFailureLatch
final CountDownLatch masterUnregistrationSuccessLatch

Detailed Description

Author:
damonkohler@google.com (Damon Kohler)

Definition at line 27 of file CountDownRegistrantListener.java.


Constructor & Destructor Documentation

org.ros.internal.node.CountDownRegistrantListener< T >.CountDownRegistrantListener ( ) [inline]

Construct a CountDownPublisherListener with all counts set to 1.

Definition at line 37 of file CountDownRegistrantListener.java.

org.ros.internal.node.CountDownRegistrantListener< T >.CountDownRegistrantListener ( int  masterRegistrationSuccessCount,
int  masterRegistrationFailureCount,
int  masterUnregistrationSuccessCount,
int  masterUnregistrationFailureCount 
) [inline]
Parameters:
masterRegistrationSuccessCountthe number of successful master registrations to wait for
masterRegistrationFailureCountthe number of failing master registrations to wait for
masterUnregistrationSuccessCountthe number of successful master unregistrations to wait for
masterUnregistrationFailureCountthe number of failing master unregistrations to wait for

Definition at line 51 of file CountDownRegistrantListener.java.

org.ros.internal.node.CountDownRegistrantListener< T >.CountDownRegistrantListener ( CountDownLatch  masterRegistrationSuccessLatch,
CountDownLatch  masterRegistrationFailureLatch,
CountDownLatch  masterUnregistrationSuccessLatch,
CountDownLatch  masterUnregistrationFailureLatch 
) [inline]

Definition at line 59 of file CountDownRegistrantListener.java.


Member Function Documentation

void org.ros.internal.node.CountDownRegistrantListener< T >.awaitMasterRegistrationFailure ( ) throws InterruptedException [inline]

Wait for the requested number of failed registrations.

Exceptions:
InterruptedException

Definition at line 146 of file CountDownRegistrantListener.java.

boolean org.ros.internal.node.CountDownRegistrantListener< T >.awaitMasterRegistrationFailure ( long  timeout,
TimeUnit  unit 
) throws InterruptedException [inline]

Wait for the requested number of failed registrations within the given time period.

Parameters:
timeoutthe maximum time to wait
unitthe TimeUnit of the
 timeout 
argument
Returns:
 true 
if the registration happened within the time period,
 false 
otherwise
Exceptions:
InterruptedException

Definition at line 162 of file CountDownRegistrantListener.java.

void org.ros.internal.node.CountDownRegistrantListener< T >.awaitMasterRegistrationSuccess ( ) throws InterruptedException [inline]

Wait for the requested number of successful registrations.

Exceptions:
InterruptedException

Definition at line 94 of file CountDownRegistrantListener.java.

boolean org.ros.internal.node.CountDownRegistrantListener< T >.awaitMasterRegistrationSuccess ( long  timeout,
TimeUnit  unit 
) throws InterruptedException [inline]

Wait for the requested number of successful registrations within the given time period.

Parameters:
timeoutthe maximum time to wait
unitthe TimeUnit of the
 timeout 
argument
Returns:
 true 
if the registration happened within the time period,
 false 
otherwise
Exceptions:
InterruptedException

Definition at line 110 of file CountDownRegistrantListener.java.

void org.ros.internal.node.CountDownRegistrantListener< T >.awaitMasterUnregistrationFailure ( ) throws InterruptedException [inline]

Wait for the requested number of failed unregistrations.

Exceptions:
InterruptedException

Definition at line 172 of file CountDownRegistrantListener.java.

boolean org.ros.internal.node.CountDownRegistrantListener< T >.awaitMasterUnregistrationFailure ( long  timeout,
TimeUnit  unit 
) throws InterruptedException [inline]

Wait for the requested number of failed unregistrations within the given time period.

Parameters:
timeoutthe maximum time to wait
unitthe TimeUnit of the
 timeout 
argument
Returns:
 true 
if the unregistration happened within the time period,
 false 
otherwise
Exceptions:
InterruptedException

Definition at line 188 of file CountDownRegistrantListener.java.

void org.ros.internal.node.CountDownRegistrantListener< T >.awaitMasterUnregistrationSuccess ( ) throws InterruptedException [inline]

Wait for the requested number of successful unregistrations.

Exceptions:
InterruptedException

Definition at line 120 of file CountDownRegistrantListener.java.

boolean org.ros.internal.node.CountDownRegistrantListener< T >.awaitMasterUnregistrationSuccess ( long  timeout,
TimeUnit  unit 
) throws InterruptedException [inline]

Wait for the requested number of successful unregistrations within the given time period.

Parameters:
timeoutthe maximum time to wait
unitthe TimeUnit of the
 timeout 
argument
Returns:
 true 
if the unregistration happened within the time period,
 false 
otherwise
Exceptions:
InterruptedException

Definition at line 136 of file CountDownRegistrantListener.java.

void org.ros.internal.node.CountDownRegistrantListener< T >.onMasterRegistrationFailure ( registrant) [inline]

The registrant has failed to register with the master.

This may be called multiple times per registrant since master registration will be retried until success.

Parameters:
registrantthe registrant which has been registered

Implements org.ros.internal.node.RegistrantListener< T >.

Definition at line 75 of file CountDownRegistrantListener.java.

void org.ros.internal.node.CountDownRegistrantListener< T >.onMasterRegistrationSuccess ( registrant) [inline]

The registrant has been registered with the master.

Parameters:
registrantthe registrant which has been registered

Implements org.ros.internal.node.RegistrantListener< T >.

Definition at line 70 of file CountDownRegistrantListener.java.

void org.ros.internal.node.CountDownRegistrantListener< T >.onMasterUnregistrationFailure ( registrant) [inline]

The registrant has failed to unregister with the master.

This may be called multiple times per registrant since master unregistration will be retried until success.

Parameters:
registrantthe registrant which has been unregistered

Implements org.ros.internal.node.RegistrantListener< T >.

Definition at line 85 of file CountDownRegistrantListener.java.

void org.ros.internal.node.CountDownRegistrantListener< T >.onMasterUnregistrationSuccess ( registrant) [inline]

The registrant has been unregistered with the master.

Parameters:
registrantthe registrant which has been unregistered

Implements org.ros.internal.node.RegistrantListener< T >.

Definition at line 80 of file CountDownRegistrantListener.java.


Member Data Documentation

final CountDownLatch org.ros.internal.node.CountDownRegistrantListener< T >.masterRegistrationFailureLatch [private]

Definition at line 30 of file CountDownRegistrantListener.java.

final CountDownLatch org.ros.internal.node.CountDownRegistrantListener< T >.masterRegistrationSuccessLatch [private]

Definition at line 29 of file CountDownRegistrantListener.java.

final CountDownLatch org.ros.internal.node.CountDownRegistrantListener< T >.masterUnregistrationFailureLatch [private]

Definition at line 32 of file CountDownRegistrantListener.java.

final CountDownLatch org.ros.internal.node.CountDownRegistrantListener< T >.masterUnregistrationSuccessLatch [private]

Definition at line 31 of file CountDownRegistrantListener.java.


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


rosjava_core
Author(s):
autogenerated on Wed Aug 26 2015 16:06:50