Public Member Functions | Private Member Functions | Private Attributes | List of all members
grpc_health.v1._async.HealthServicer Class Reference
Inheritance diagram for grpc_health.v1._async.HealthServicer:
Inheritance graph
[legend]

Public Member Functions

None __init__ (self)
 
None Check (self, _health_pb2.HealthCheckRequest request, context)
 
None enter_graceful_shutdown (self)
 
None set (self, str service, _health_pb2.HealthCheckResponse.ServingStatus status)
 
None Watch (self, _health_pb2.HealthCheckRequest request, context)
 

Private Member Functions

None _set (self, str service, _health_pb2.HealthCheckResponse.ServingStatus status)
 

Private Attributes

 _gracefully_shutting_down
 
 _server_status
 
 _server_watchers
 

Detailed Description

An AsyncIO implementation of health checking servicer.

Definition at line 25 of file grpcio_health_checking/grpc_health/v1/_async.py.

Constructor & Destructor Documentation

◆ __init__()

None grpc_health.v1._async.HealthServicer.__init__ (   self)

Member Function Documentation

◆ _set()

None grpc_health.v1._async.HealthServicer._set (   self,
str  service,
_health_pb2.HealthCheckResponse.ServingStatus  status 
)
private

◆ Check()

None grpc_health.v1._async.HealthServicer.Check (   self,
_health_pb2.HealthCheckRequest  request,
  context 
)

◆ enter_graceful_shutdown()

None grpc_health.v1._async.HealthServicer.enter_graceful_shutdown (   self)
Permanently sets the status of all services to NOT_SERVING.

This should be invoked when the server is entering a graceful shutdown
period. After this method is invoked, future attempts to set the status
of a service will be ignored.

Definition at line 100 of file grpcio_health_checking/grpc_health/v1/_async.py.

◆ set()

None grpc_health.v1._async.HealthServicer.set (   self,
str  service,
_health_pb2.HealthCheckResponse.ServingStatus  status 
)
Sets the status of a service.

Args:
  service: string, the name of the service.
  status: HealthCheckResponse.status enum value indicating the status of
    the service

Definition at line 85 of file grpcio_health_checking/grpc_health/v1/_async.py.

◆ Watch()

None grpc_health.v1._async.HealthServicer.Watch (   self,
_health_pb2.HealthCheckRequest  request,
  context 
)

Member Data Documentation

◆ _gracefully_shutting_down

grpc_health.v1._async.HealthServicer._gracefully_shutting_down
private

◆ _server_status

grpc_health.v1._async.HealthServicer._server_status
private

◆ _server_watchers

grpc_health.v1._async.HealthServicer._server_watchers
private

The documentation for this class was generated from the following file:


grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:40