Public Member Functions | Private Attributes
org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl Class Reference
Inheritance diagram for org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl:
Inheritance graph
[legend]

List of all members.

Public Member Functions

List< Object > deleteParam (String callerId, String key)
List< Object > getParam (String callerId, String key)
List< Object > getParamNames (String callerId)
List< Object > getPid (String callerId)
List< Object > getPublishedTopics (String callerId, String subgraph)
List< Object > getSystemState (String callerId)
List< Object > getTopicTypes (String callerId)
List< Object > getUri (String callerId)
List< Object > hasParam (String callerId, String key)
List< Object > lookupNode (String callerId, String nodeName)
List< Object > lookupService (String callerId, String serviceName)
 MasterXmlRpcEndpointImpl (MasterServer master)
List< Object > registerPublisher (String callerId, String topicName, String topicMessageType, String callerSlaveUri)
List< Object > registerService (String callerId, String serviceName, String serviceUri, String callerSlaveUri)
List< Object > registerSubscriber (String callerId, String topicName, String topicMessageType, String callerSlaveUri)
List< Object > searchParam (String callerId, String key)
List< Object > setParam (String callerId, String key, Boolean value)
List< Object > setParam (String callerId, String key, Integer value)
List< Object > setParam (String callerId, String key, Double value)
List< Object > setParam (String callerId, String key, String value)
List< Object > setParam (String callerId, String key, List<?> value)
List< Object > setParam (String callerId, String key, Map<?,?> value)
List< Object > subscribeParam (String callerId, String callerSlaveUri, String key)
List< Object > unregisterPublisher (String callerId, String topicName, String callerSlaveUri)
List< Object > unregisterService (String callerId, String serviceName, String serviceUri)
List< Object > unregisterSubscriber (String callerId, String topicName, String callerSlaveUri)
List< Object > unsubscribeParam (String callerId, String callerSlaveUri, String key)

Private Attributes

final MasterServer master
final ParameterServer parameterServer

Detailed Description

A combined XML-RPC endpoint for the master and parameter servers.

Author:
damonkohler@google.com (Damon Kohler)

Definition at line 40 of file MasterXmlRpcEndpointImpl.java.

Constructor & Destructor Documentation

org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.MasterXmlRpcEndpointImpl ( MasterServer  master) [inline]

Definition at line 46 of file MasterXmlRpcEndpointImpl.java.

Member Function Documentation

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.deleteParam ( String  callerId,
String  key 
) [inline]

Deletes a parameter.

Parameters:
callerIdROS caller ID
keyparameter name
Returns:
void

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 238 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.getParam ( String  callerId,
String  key 
) [inline]

Retrieve parameter value from server.

If code is not 1, parameterValue should be ignored. If key is a namespace, the return value will be a dictionary, where each key is a parameter in that namespace. Sub-namespaces are also represented as dictionaries.

Parameters:
callerIdROS caller ID
keyParameter name. If key is a namespace, getParam() will return a parameter tree.
Returns:
the parameter value

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 207 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.getParamNames ( String  callerId) [inline]

Gets the list of all parameter names stored on this server.

Parameters:
callerIdROS caller ID.
Returns:
a Collection of parameter names

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 249 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.getPid ( String  callerId) [inline]

Get the PID for the master process.

Parameters:
callerIdROS caller ID
Returns:
The pid of the process.

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 52 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.getPublishedTopics ( String  callerId,
String  subgraph 
) [inline]

Get list of topics that can be subscribed to. This does not return topics that have no publishers. See getSystemState() to get more comprehensive list.

Parameters:
callerIdROS caller ID
subgraphRestrict topic names to match within the specified subgraph. Subgraph namespace is resolved relative to the caller's namespace. Use empty string to specify all names.
Returns:
Topics is in list representation [[topic, message type], [topic, message type] ...]

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 57 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.getSystemState ( String  callerId) [inline]

Retrieve list representation of system state (i.e. publishers, subscribers, and services).

Parameters:
callerIdROS caller ID
Returns:
System state is in list representation [publishers, subscribers, services] publishers is of the form [ [topic1, [topic1Publisher1...topic1PublisherN]] ... ] subscribers is of the form [ [topic1, [topic1Subscriber1...topic1SubscriberN]] ... ] services is of the form [ [service1, [service1Provider1...service1ProviderN]] ... ]

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 69 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.getTopicTypes ( String  callerId) [inline]

Get a list of all topic types.

Parameters:
callerIdROS caller ID
Returns:
The types are in the list representation [[topic, message type], [topic, message type] ...]

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 63 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.getUri ( String  callerId) [inline]

Get the URI of the the master.

Parameters:
callerIdROS caller ID
Returns:
URI of the the master

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 74 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.hasParam ( String  callerId,
String  key 
) [inline]

Check if parameter is stored on server.

Parameters:
callerIdROS caller ID.
keyParameter name.
Returns:
 true
if the parameter exists

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 244 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.lookupNode ( String  callerId,
String  nodeName 
) [inline]

Get the XML-RPC URI of the node with the associated name/caller_id. This API is for looking information about publishers and subscribers. Use lookupService instead to lookup ROS-RPC URIs.

Parameters:
callerIdROS caller ID
nodeNameName of node to lookup
Returns:
URI of the node

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 79 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.lookupService ( String  callerId,
String  service 
) [inline]

Lookup all provider of a particular service.

Parameters:
callerIdROS caller ID
serviceFully-qualified name of service
Returns:
service URL is provides address and port of the service. Fails if there is no provider.

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 138 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.registerPublisher ( String  callerId,
String  topicName,
String  topicType,
String  callerApi 
) [inline]

Register the caller as a publisher the topic.

Parameters:
callerIdROS caller ID
topicNamefully-qualified name of topic to register
topicTypetopic type, must be a package-resource name, i.e. the .msg name.
callerApiAPI URI of publisher to register
Returns:
list of current subscribers of topic in the form of XML-RPC URIs

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 89 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.registerService ( String  callerId,
String  service,
String  serviceApi,
String  callerApi 
) [inline]

Register the caller as a provider of the specified service.

Parameters:
callerIdROS caller ID
serviceFully-qualified name of service
serviceApiXML-RPC URI of caller node
callerApi
Returns:
ignore

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 147 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.registerSubscriber ( String  callerId,
String  topicName,
String  topicType,
String  callerApi 
) [inline]

Subscribe the caller to the specified topic. In addition to receiving a list of current publishers, the subscriber will also receive notifications of new publishers via the publisherUpdate API.

Parameters:
callerIdROS caller ID
topicNameFully-qualified name of topic
topicTypetopic type, must be a package-resource name, i.e. the .msg name
callerApiAPI URI of subscriber to register. Will be used for new publisher notifications
Returns:
publishers as a list of XMLRPC API URIs for nodes currently publishing the specified topic

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 113 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.searchParam ( String  callerId,
String  key 
) [inline]

Searches for a parameter key on the ParameterServer.

Search starts in caller's namespace and proceeds upwards through parent namespaces until Parameter Server finds a matching key. searchParam()'s behavior is to search for the first partial match. For example, imagine that there are two 'robot_description' parameters /robot_description /robot_description/arm /robot_description/base /pr2/robot_description /pr2/robot_description/base If I start in the namespace /pr2/foo and search for robot_description, searchParam() will match /pr2/robot_description. If I search for robot_description/arm it will return /pr2/robot_description/arm, even though that parameter does not exist (yet).

If code is not 1, foundKey should be ignored.

Parameters:
callerIdROS caller ID
keyParameter name to search for.
Returns:
the found key

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 216 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.setParam ( String  callerId,
String  key,
Boolean  value 
) [inline]

Sets a parameter.

NOTE: if value is a dictionary it will be treated as a parameter tree, where key is the parameter namespace. For example {'x':1,'y':2,'sub':{'z':3}} will set key/x=1, key/y=2, and key/sub/z=3. Furthermore, it will replace all existing parameters in the key parameter namespace with the parameters in value. You must set parameters individually if you wish to perform a union update.

Parameters:
callerIdROS caller ID
keyParameter name.
valueParameter value.
Returns:
void

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 171 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.setParam ( String  callerId,
String  key,
Integer  value 
) [inline]

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 177 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.setParam ( String  callerId,
String  key,
Double  value 
) [inline]

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 183 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.setParam ( String  callerId,
String  key,
String  value 
) [inline]

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 189 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.setParam ( String  callerId,
String  key,
List<?>  value 
) [inline]

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 195 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.setParam ( String  callerId,
String  key,
Map<?,?>  value 
) [inline]

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 201 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.subscribeParam ( String  callerId,
String  callerApi,
String  key 
) [inline]

Retrieves the parameter value from server and subscribe to updates to that param. See paramUpdate() in the Node API.

If code is not 1, parameterValue should be ignored. parameterValue is an empty dictionary if the parameter has not been set yet.

Parameters:
callerIdROS caller ID
callerApiNode API URI of subscriber for paramUpdate callbacks.
key
Returns:
the parameter value

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 221 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.unregisterPublisher ( String  callerId,
String  topicName,
String  callerApi 
) [inline]

Unregister the caller as a publisher of the topic.

Parameters:
callerIdROS caller ID
topicNameFully-qualified name of topic.
callerApiAPI URI of publisher to unregister. Unregistration will only occur if current registration matches.
Returns:
If numUnsubscribed is zero it means that the caller was not registered as a subscriber. The call still succeeds as the intended final state is reached.

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 107 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.unregisterService ( String  callerId,
String  service,
String  serviceApi 
) [inline]

Unregister the caller as a provider of the specified service.

Parameters:
callerIdROS caller ID
serviceFully-qualified name of service
serviceApiAPI URI of service to unregister. Unregistration will only occur if current registration matches.
Returns:
Number of unregistrations (either 0 or 1). If this is zero it means that the caller was not registered as a service provider. The call still succeeds as the intended final state is reached.

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 159 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.unregisterSubscriber ( String  callerId,
String  topicName,
String  callerApi 
) [inline]

Unregister the caller as a publisher of the topic.

Parameters:
callerIdROS caller ID
topicNameFully-qualified name of topic.
callerApiAPI URI of service to unregister. Unregistration will only occur if current registration matches.
Returns:
If numUnsubscribed is zero it means that the caller was not registered as a subscriber. The call still succeeds as the intended final state is reached.

Implements org.ros.internal.node.xmlrpc.MasterXmlRpcEndpoint.

Definition at line 132 of file MasterXmlRpcEndpointImpl.java.

List<Object> org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.unsubscribeParam ( String  callerId,
String  callerApi,
String  key 
) [inline]

Unsubscribes from updates to the specified param. See paramUpdate() in the Node API.

A return value of zero means that the caller was not subscribed to the parameter.

Parameters:
callerIdROS caller ID
callerApiNode API URI of subscriber
keyParameter name
Returns:
the number of parameters that were unsubscribed

Implements org.ros.internal.node.xmlrpc.ParameterServerXmlRpcEndpoint.

Definition at line 233 of file MasterXmlRpcEndpointImpl.java.

Member Data Documentation

final MasterServer org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.master [private]

Definition at line 43 of file MasterXmlRpcEndpointImpl.java.

final ParameterServer org.ros.internal.node.xmlrpc.MasterXmlRpcEndpointImpl.parameterServer [private]

Definition at line 44 of file MasterXmlRpcEndpointImpl.java.

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

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