Class

DirectoryClient

DirectoryClient()

Constructor

# new DirectoryClient()

List robot services and get information on them.

View Source bosdyn-client/directory.js, line 47

Extends

  • BaseClient

Methods

# get_entry(service_name, args) → {Promise.<directory_pb.GetServiceEntryResponse>}

Get the service entry for one particular service specified by name.
Parameters:
Name Type Description
service_name string The name of the service to retrieve.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/directory.js, line 84

Problem communicating with the robot.
RpcError
The service was not found.
NonexistentServiceError
Something went wrong during the directory access.
DirectoryResponseError
The proto message definition of the service entry
Promise.<directory_pb.GetServiceEntryResponse>

# list(args) → {Promise.<Array>}

List all services present on the robot.
Parameters:
Name Type Description
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/directory.js, line 70

Problem communicating with the robot.
RpcError
A list of the proto message definitions of all registered services
Promise.<Array>

DirectoryClient(nameopt)

Constructor

# new DirectoryClient(nameopt)

Create an instance of DirectoryClient's class.
Parameters:
Name Type Attributes Default Description
name string <optional>
null Name of the Class.

View Source bosdyn-client/directory.js, line 60

Methods

# get_entry(service_name, args) → {Promise.<directory_pb.GetServiceEntryResponse>}

Get the service entry for one particular service specified by name.
Parameters:
Name Type Description
service_name string The name of the service to retrieve.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/directory.js, line 84

Problem communicating with the robot.
RpcError
The service was not found.
NonexistentServiceError
Something went wrong during the directory access.
DirectoryResponseError
The proto message definition of the service entry
Promise.<directory_pb.GetServiceEntryResponse>

# list(args) → {Promise.<Array>}

List all services present on the robot.
Parameters:
Name Type Description
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/directory.js, line 70

Problem communicating with the robot.
RpcError
A list of the proto message definitions of all registered services
Promise.<Array>