viam.rpc.server

Module Contents

Classes

Server

gRPC Server

Attributes

LOGGER

viam.rpc.server.LOGGER
class viam.rpc.server.Server(resources: List[viam.resource.base.ResourceBase], *, module_service: Optional[viam.module.service.ModuleRPCService] = None)[source]

Bases: viam.resource.manager.ResourceManager

gRPC Server

async serve(host: Optional[str] = 'localhost', port: Optional[int] = 9090, log_level: Optional[int] = logging.INFO, *, path: Optional[str] = None)[source]

Server the gRPC server on the provided host and port

Parameters:

  • host (Optional[str], optional) – Desired hostname of the server. Defaults to “localhost”.

  • port (Optional[int], optional) – Desired port of the server. Defaults to 9090.

  • log_level (Optional[int], optional) – The minimum log level. To not receive any logs, set to None. Defaults to logging.INFO.

  • path (Optional[str], optional) – UNIX socket path. Takes precedence over host and port if set. Defaults to None.

async classmethod create_and_serve(components: List[viam.resource.base.ResourceBase], host: Optional[str] = 'localhost', port: Optional[int] = 9090, log_level: int = logging.INFO, *, path: Optional[str] = None)[source]

Convenience method to create and start the server.

Parameters:

  • components (List[ComponentBase]) – List of components to manage

  • host (str, optional) – Desired hostname. Defaults to “localhost”.

  • port (int, optional) – Desired port. Defaults to 9090.

  • log_level (int, optional) – The minimum log level. To not receive any logs, set to None. Defaults to logging.INFO

  • path (Optional[str], optional) – UNIX socket path. Takes precedence over host and port if set. Defaults to None.

async close()

Close the resourcce manager by removing all resources. Please note that any errors will not raise an exception. Errors will still be logged.