org.ros.internal.node.client.Registrar Class Reference

Inheritance diagram for org.ros.internal.node.client.Registrar:

List of all members.

Public Member Functions
void	onPublisherAdded (final DefaultPublisher<?> publisher)
void	onPublisherRemoved (final DefaultPublisher<?> publisher)
void	onServiceServerAdded (final DefaultServiceServer<?,?> serviceServer)
void	onServiceServerRemoved (final DefaultServiceServer<?,?> serviceServer)
void	onSubscriberAdded (final DefaultSubscriber<?> subscriber)
void	onSubscriberRemoved (final DefaultSubscriber<?> subscriber)
	Registrar (MasterClient masterClient, ScheduledExecutorService executorService)
void	setRetryDelay (long delay, TimeUnit unit)
void	shutdown ()
void	start (NodeIdentifier nodeIdentifier)
Package Functions
private< T > boolean	callMaster (Callable< Response< T >> callable)
Private Member Functions
boolean	submit (Callable< Boolean > callable)
Private Attributes
final ScheduledExecutorService	executorService
final MasterClient	masterClient
NodeIdentifier	nodeIdentifier
final RetryingExecutorService	retryingExecutorService
boolean	running
Static Private Attributes
static final boolean	DEBUG = true
static final Log	log = LogFactory.getLog(Registrar.class)
static final int	SHUTDOWN_TIMEOUT = 5
static final TimeUnit	SHUTDOWN_TIMEOUT_UNITS = TimeUnit.SECONDS

---

Detailed Description

Manages topic, and service registrations of a SlaveServer with the MasterServer.

Author:

kwc@willowgarage.com (Ken Conley)

damonkohler@google.com (Damon Kohler)

Definition at line 51 of file Registrar.java.

---

Constructor & Destructor Documentation

org.ros.internal.node.client.Registrar.Registrar	(	MasterClient	masterClient,
		ScheduledExecutorService	executorService
	)		[inline]

Parameters:

masterClient	a MasterClient for communicating with the ROS master
executorService	a ScheduledExecutorService to be used for all asynchronous operations

Definition at line 73 of file Registrar.java.

---

Member Function Documentation

private<T> boolean org.ros.internal.node.client.Registrar.callMaster

(

Callable< Response< T >>

callable

)

[inline, package]

Definition at line 107 of file Registrar.java.

void org.ros.internal.node.client.Registrar.onPublisherAdded

(

final DefaultPublisher<?>

publisher

)

[inline]

Definition at line 128 of file Registrar.java.

void org.ros.internal.node.client.Registrar.onPublisherRemoved

(

final DefaultPublisher<?>

publisher

)

[inline]

Definition at line 160 of file Registrar.java.

void org.ros.internal.node.client.Registrar.onServiceServerAdded

(

final DefaultServiceServer<?,?>

serviceServer

)

[inline]

Definition at line 261 of file Registrar.java.

void org.ros.internal.node.client.Registrar.onServiceServerRemoved

(

final DefaultServiceServer<?,?>

serviceServer

)

[inline]

Definition at line 293 of file Registrar.java.

void org.ros.internal.node.client.Registrar.onSubscriberAdded

(

final DefaultSubscriber<?>

subscriber

)

[inline]

Definition at line 192 of file Registrar.java.

void org.ros.internal.node.client.Registrar.onSubscriberRemoved

(

final DefaultSubscriber<?>

subscriber

)

[inline]

Definition at line 229 of file Registrar.java.

void org.ros.internal.node.client.Registrar.setRetryDelay	(	long	delay,
		TimeUnit	unit
	)		[inline]

Failed registration actions are retried periodically until they succeed. This method adjusts the delay between successive retry attempts for any particular registration action.

Parameters:

delay	the delay in units of unit between retries
unit	the unit of delay

Definition at line 94 of file Registrar.java.

void org.ros.internal.node.client.Registrar.shutdown

(

)

[inline]

Shuts down the Registrar.

No further registration requests will be accepted. All queued registration jobs have up to SHUTDOWN_TIMEOUT SHUTDOWN_TIMEOUT_UNITS to complete before being canceled.

Calling shutdown() more than once has no effect.

Definition at line 350 of file Registrar.java.

void org.ros.internal.node.client.Registrar.start

(

NodeIdentifier

nodeIdentifier

)

[inline]

Starts the Registrar for the SlaveServer identified by the given NodeIdentifier.

Parameters:

nodeIdentifier

the NodeIdentifier for the SlaveServer this Registrar is responsible for

Definition at line 332 of file Registrar.java.

boolean org.ros.internal.node.client.Registrar.submit

(

Callable< Boolean >

callable

)

[inline, private]

Definition at line 98 of file Registrar.java.

---

Member Data Documentation

final boolean org.ros.internal.node.client.Registrar.DEBUG = true [static, private]

Definition at line 53 of file Registrar.java.

final ScheduledExecutorService org.ros.internal.node.client.Registrar.executorService [private]

Definition at line 60 of file Registrar.java.

final Log org.ros.internal.node.client.Registrar.log = LogFactory.getLog(Registrar.class) [static, private]

Definition at line 54 of file Registrar.java.

final MasterClient org.ros.internal.node.client.Registrar.masterClient [private]

Definition at line 59 of file Registrar.java.

NodeIdentifier org.ros.internal.node.client.Registrar.nodeIdentifier [private]

Definition at line 63 of file Registrar.java.

final RetryingExecutorService org.ros.internal.node.client.Registrar.retryingExecutorService [private]

Definition at line 61 of file Registrar.java.

boolean org.ros.internal.node.client.Registrar.running [private]

Definition at line 64 of file Registrar.java.

final int org.ros.internal.node.client.Registrar.SHUTDOWN_TIMEOUT = 5 [static, private]

Definition at line 56 of file Registrar.java.

final TimeUnit org.ros.internal.node.client.Registrar.SHUTDOWN_TIMEOUT_UNITS = TimeUnit.SECONDS [static, private]

Definition at line 57 of file Registrar.java.

---

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

• Registrar.java