grpc_health.v1.health.HealthServicer Class Reference

Inheritance diagram for grpc_health.v1.health.HealthServicer:

Public Member Functions
def	__init__ (self, experimental_non_blocking=True, experimental_thread_pool=None)
def	Check (self, request, context)
def	enter_graceful_shutdown (self)
def	set (self, service, status)
def	Watch (self, request, context, send_response_callback=None)

Private Member Functions
def	_on_close_callback (self, send_response_callback, service)

Private Attributes
	_gracefully_shutting_down
	_lock
	_send_response_callbacks
	_server_status

Detailed Description

Servicer handling RPCs for service statuses.

Definition at line 81 of file health.py.

Constructor & Destructor Documentation

__init__()

def grpc_health.v1.health.HealthServicer.__init__	(		self,
			experimental_non_blocking = True,
			experimental_thread_pool = None
	)

Definition at line 84 of file health.py.

Member Function Documentation

_on_close_callback()

def grpc_health.v1.health.HealthServicer._on_close_callback (   self,   send_response_callback,   service  )

private

Definition at line 94 of file health.py.

Check()

def grpc_health.v1.health.HealthServicer.Check	(		self,
			request,
			context
	)

Definition at line 104 of file health.py.

enter_graceful_shutdown()

def grpc_health.v1.health.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.

This is an EXPERIMENTAL API.

Definition at line 156 of file health.py.

set()

def grpc_health.v1.health.HealthServicer.set	(		self,
			service,
			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 137 of file health.py.

Watch()

def grpc_health.v1.health.HealthServicer.Watch	(		self,
			request,
			context,
			send_response_callback = None
	)

Definition at line 114 of file health.py.

Member Data Documentation

_gracefully_shutting_down

grpc_health.v1.health.HealthServicer._gracefully_shutting_down

private

Definition at line 90 of file health.py.

_lock

grpc_health.v1.health.HealthServicer._lock

private

Definition at line 85 of file health.py.

_send_response_callbacks

grpc_health.v1.health.HealthServicer._send_response_callbacks

private

Definition at line 87 of file health.py.

_server_status

grpc_health.v1.health.HealthServicer._server_status

private

Definition at line 86 of file health.py.

---

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

• health.py