Directory
Client for the directory service.
- A DirectoryClient allows a client to look-up information about other API services available on a
robot.
- exception bosdyn.client.directory.DirectoryResponseError(response, error_message=None)[source]
Bases:
ResponseError
General class of errors for Directory service.
- exception bosdyn.client.directory.NonexistentServiceError(response, error_message=None)[source]
Bases:
DirectoryResponseError
The requested service name does not exist.
- class bosdyn.client.directory.DirectoryClient[source]
Bases:
BaseClient
List robot services and get information on them.
- default_service_name = 'directory'
- service_type = 'bosdyn.api.DirectoryService'
- list(**kwargs)[source]
List all services present on the robot.
- Returns:
A list of the proto message definitions of all registered services
- Raises:
RpcError – Problem communicating with the robot.
- list_async(**kwargs)[source]
List all services present on the robot.
- Returns:
A list of the proto message definitions of all registered services
- Raises:
RpcError – Problem communicating with the robot.
- get_entry(service_name, **kwargs)[source]
Get the service entry for one particular service specified by name.
- Parameters:
service_name – The name of the service to retrieve.
- Returns:
The proto message definition of the service entry
- Raises:
RpcError – Problem communicating with the robot.
NonexistentServiceError – The service was not found.
DirectoryResponseError – Something went wrong during the directory access.
- get_entry_async(service_name, **kwargs)[source]
Get the service entry for one particular service specified by name.
- Parameters:
service_name – The name of the service to retrieve.
- Returns:
The proto message definition of the service entry
- Raises:
RpcError – Problem communicating with the robot.
NonexistentServiceError – The service was not found.
DirectoryResponseError – Something went wrong during the directory access.