|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MasterXmlRpcEndpoint
An XML-RPC endpoint description of a ROS master.
Method Summary | |
---|---|
java.util.List<java.lang.Object> |
getPid(java.lang.String callerId)
Get the PID for the master process. |
java.util.List<java.lang.Object> |
getPublishedTopics(java.lang.String callerId,
java.lang.String subgraph)
Get list of topics that can be subscribed to. |
java.util.List<java.lang.Object> |
getSystemState(java.lang.String callerId)
Retrieve list representation of system state (i.e. |
java.util.List<java.lang.Object> |
getTopicTypes(java.lang.String callerId)
Get a list of all topic types. |
java.util.List<java.lang.Object> |
getUri(java.lang.String callerId)
Get the URI of the the master. |
java.util.List<java.lang.Object> |
lookupNode(java.lang.String callerId,
java.lang.String nodeName)
Get the XML-RPC URI of the node with the associated name/caller_id. |
java.util.List<java.lang.Object> |
lookupService(java.lang.String callerId,
java.lang.String service)
Lookup all provider of a particular service. |
java.util.List<java.lang.Object> |
registerPublisher(java.lang.String callerId,
java.lang.String topicName,
java.lang.String topicType,
java.lang.String callerApi)
Register the caller as a publisher the topic. |
java.util.List<java.lang.Object> |
registerService(java.lang.String callerId,
java.lang.String service,
java.lang.String serviceApi,
java.lang.String callerApi)
Register the caller as a provider of the specified service. |
java.util.List<java.lang.Object> |
registerSubscriber(java.lang.String callerId,
java.lang.String topicName,
java.lang.String topicType,
java.lang.String callerApi)
Subscribe the caller to the specified topic. |
java.util.List<java.lang.Object> |
unregisterPublisher(java.lang.String callerId,
java.lang.String topicName,
java.lang.String callerApi)
Unregister the caller as a publisher of the topic. |
java.util.List<java.lang.Object> |
unregisterService(java.lang.String callerId,
java.lang.String service,
java.lang.String serviceApi)
Unregister the caller as a provider of the specified service. |
java.util.List<java.lang.Object> |
unregisterSubscriber(java.lang.String callerId,
java.lang.String topicName,
java.lang.String callerApi)
Unregister the caller as a publisher of the topic. |
Method Detail |
---|
java.util.List<java.lang.Object> getPid(java.lang.String callerId)
callerId
- ROS caller ID
java.util.List<java.lang.Object> registerService(java.lang.String callerId, java.lang.String service, java.lang.String serviceApi, java.lang.String callerApi)
callerId
- ROS caller IDservice
- Fully-qualified name of serviceserviceApi
- XML-RPC URI of caller nodecallerApi
-
java.util.List<java.lang.Object> unregisterService(java.lang.String callerId, java.lang.String service, java.lang.String serviceApi)
callerId
- ROS caller IDservice
- Fully-qualified name of serviceserviceApi
- API URI of service to unregister. Unregistration will only occur
if current registration matches.
java.util.List<java.lang.Object> registerSubscriber(java.lang.String callerId, java.lang.String topicName, java.lang.String topicType, java.lang.String callerApi)
callerId
- ROS caller IDtopicName
- Fully-qualified name of topictopicType
- topic type, must be a package-resource name, i.e. the .msg namecallerApi
- API URI of subscriber to register. Will be used for new publisher
notifications
java.util.List<java.lang.Object> unregisterSubscriber(java.lang.String callerId, java.lang.String topicName, java.lang.String callerApi)
callerId
- ROS caller IDtopicName
- Fully-qualified name of topic.callerApi
- API URI of service to unregister. Unregistration will only occur
if current registration matches.
java.util.List<java.lang.Object> registerPublisher(java.lang.String callerId, java.lang.String topicName, java.lang.String topicType, java.lang.String callerApi)
callerId
- ROS caller IDtopicName
- fully-qualified name of topic to registertopicType
- topic type, must be a package-resource name, i.e. the .msg name.callerApi
- API URI of publisher to register
java.util.List<java.lang.Object> unregisterPublisher(java.lang.String callerId, java.lang.String topicName, java.lang.String callerApi)
callerId
- ROS caller IDtopicName
- Fully-qualified name of topic.callerApi
- API URI of publisher to unregister. Unregistration will only occur
if current registration matches.
java.util.List<java.lang.Object> lookupNode(java.lang.String callerId, java.lang.String nodeName)
callerId
- ROS caller IDnodeName
- Name of node to lookup
java.util.List<java.lang.Object> getPublishedTopics(java.lang.String callerId, java.lang.String subgraph)
callerId
- ROS caller IDsubgraph
- Restrict 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.
java.util.List<java.lang.Object> getTopicTypes(java.lang.String callerId)
callerId
- ROS caller ID
java.util.List<java.lang.Object> getSystemState(java.lang.String callerId)
callerId
- ROS caller ID
java.util.List<java.lang.Object> getUri(java.lang.String callerId)
callerId
- ROS caller ID
java.util.List<java.lang.Object> lookupService(java.lang.String callerId, java.lang.String service)
callerId
- ROS caller IDservice
- Fully-qualified name of service
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |