Public Member Functions
org.ros.internal.node.client.MasterClient Class Reference

List of all members.

Public Member Functions

Response< List
< TopicDeclaration > > 
getPublishedTopics (GraphName callerName, String subgraph)
Response< SystemStategetSystemState (GraphName callerName)
Response< List< TopicType > > getTopicTypes (GraphName callerName)
Response< URI > getUri (GraphName slaveName)
Response< URI > lookupNode (GraphName slaveName, String nodeName)
Response< URI > lookupService (GraphName callerName, String serviceName)
 MasterClient (URI uri)
Response< List< URI > > registerPublisher (PublisherDeclaration publisherDeclaration)
Response< Void > registerService (NodeIdentifier slave, ServiceServer<?,?> service)
Response< List< URI > > registerSubscriber (NodeIdentifier slave, Subscriber<?> subscriber)
Response< Integer > unregisterPublisher (PublisherIdentifier publisherIdentifier)
Response< Integer > unregisterService (NodeIdentifier slave, ServiceServer<?,?> service)
Response< Integer > unregisterSubscriber (NodeIdentifier slave, Subscriber<?> subscriber)

Detailed Description

Provides access to the XML-RPC API exposed by a MasterServer.

Author:
damonkohler@google.com (Damon Kohler)

Definition at line 50 of file MasterClient.java.


Constructor & Destructor Documentation

Create a new MasterClient connected to the specified MasterServer URI.

Parameters:
urithe URI of the MasterServer to connect to

Definition at line 59 of file MasterClient.java.


Member Function Documentation

Response<List<TopicDeclaration> > org.ros.internal.node.client.MasterClient.getPublishedTopics ( GraphName  callerName,
String  subgraph 
) [inline]
Parameters:
callerNamethe GraphName of the caller
subgraphthe subgraph of the topics
Returns:
the list of published TopicDeclarations

Definition at line 208 of file MasterClient.java.

Parameters:
callerNamethe GraphName of the caller
Returns:
the current SystemState

Definition at line 231 of file MasterClient.java.

Get a List of all TopicSystemState message types.

Parameters:
callerNamethe GraphName of the caller
Returns:
a List of TopicTypes

Definition at line 221 of file MasterClient.java.

Response<URI> org.ros.internal.node.client.MasterClient.getUri ( GraphName  slaveName) [inline]
Parameters:
slaveNamethe NodeIdentifier of the caller
Returns:
the URI of the MasterServer

Definition at line 183 of file MasterClient.java.

Response<URI> org.ros.internal.node.client.MasterClient.lookupNode ( GraphName  slaveName,
String  nodeName 
) [inline]
Parameters:
slaveNamethe GraphName of the caller
nodeNamethe name of the SlaveServer to lookup
Returns:
the URI of the SlaveServer with the given name

Definition at line 173 of file MasterClient.java.

Response<URI> org.ros.internal.node.client.MasterClient.lookupService ( GraphName  callerName,
String  serviceName 
) [inline]
Parameters:
callerNamethe GraphName of the caller
serviceNamethe name of the ServiceServer to look up
Returns:
the URI of the ServiceServer with the given name. ServiceServer as a result

Definition at line 196 of file MasterClient.java.

Response<List<URI> > org.ros.internal.node.client.MasterClient.registerPublisher ( PublisherDeclaration  publisherDeclaration) [inline]

Registers the specified PublisherDeclaration.

Parameters:
publisherDeclarationthe PublisherDeclaration of the Publisher to register
Returns:
a List of the current SlaveServer URIs which have Subscribers for the published TopicSystemState

Definition at line 139 of file MasterClient.java.

Response<Void> org.ros.internal.node.client.MasterClient.registerService ( NodeIdentifier  slave,
ServiceServer<?,?>  service 
) [inline]

Registers the given ServiceServer.

Parameters:
slavethe NodeIdentifier where the ServiceServer is running
servicethe ServiceServer to register
Returns:
a void Response

Definition at line 73 of file MasterClient.java.

Response<List<URI> > org.ros.internal.node.client.MasterClient.registerSubscriber ( NodeIdentifier  slave,
Subscriber<?>  subscriber 
) [inline]

Registers the given Subscriber. In addition to receiving a list of current Publishers, the Subscribers SlaveServer will also receive notifications of new Publishers via the publisherUpdate API.

Parameters:
slavethe NodeIdentifier that the Subscriber is running on
subscriberthe Subscriber to register
Returns:
a List or SlaveServer XML-RPC API URIs for nodes currently publishing the specified topic

Definition at line 109 of file MasterClient.java.

Response<Integer> org.ros.internal.node.client.MasterClient.unregisterPublisher ( PublisherIdentifier  publisherIdentifier) [inline]

Unregisters the specified PublisherDeclaration.

Parameters:
publisherIdentifierthe PublisherIdentifier of the Publisher to unregister
Returns:
the number of unregistered Publishers

Definition at line 157 of file MasterClient.java.

Response<Integer> org.ros.internal.node.client.MasterClient.unregisterService ( NodeIdentifier  slave,
ServiceServer<?,?>  service 
) [inline]

Unregisters the specified ServiceServer.

Parameters:
slavethe NodeIdentifier where the ServiceServer is running
servicethe ServiceServer to unregister
Returns:
the number of unregistered services

Definition at line 89 of file MasterClient.java.

Response<Integer> org.ros.internal.node.client.MasterClient.unregisterSubscriber ( NodeIdentifier  slave,
Subscriber<?>  subscriber 
) [inline]

Unregisters the specified Subscriber.

Parameters:
slavethe NodeIdentifier where the subscriber is running
subscriberthe Subscriber to unregister
Returns:
the number of unregistered Subscribers

Definition at line 124 of file MasterClient.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