The client.py module#

Summary#

GrpcClient

Wraps the gRPC connection for the Geometry service.

wait_until_healthy

Wait until a channel is healthy before returning.

Description#

Module providing a wrapped abstraction of the gRPC stubs.

Module detail#

client.wait_until_healthy(channel: grpc.Channel, timeout: float)#

Wait until a channel is healthy before returning.

Parameters:
channelChannel

Channel that must be established and healthy.

timeoutfloat

Timeout in seconds. Attempts are made with the following backoff strategy:

  • Starts with 0.1 seconds.

  • If the attempt fails, double the timeout.

  • This is repeated until the next timeoff exceeds the value for the remaining time. In that case, a final attempt is made with the remaining time.

  • If the total elapsed time exceeds the value for the timeout parameter, a TimeoutError is raised.

Raises:
TimeoutError

Raised when the total elapsed time exceeds the value for the timeout parameter.