Public Member Functions | List of all members
grpc::HealthCheckServiceInterface Class Referenceabstract

#include <health_check_service_interface.h>

Inheritance diagram for grpc::HealthCheckServiceInterface:
Inheritance graph
[legend]

Public Member Functions

virtual void SetServingStatus (bool serving)=0
 Apply to all registered service names. More...
 
virtual void SetServingStatus (const std::string &service_name, bool serving)=0
 Set or change the serving status of the given service_name. More...
 
virtual void Shutdown ()
 
virtual ~HealthCheckServiceInterface ()
 

Detailed Description

The gRPC server uses this interface to expose the health checking service without depending on protobuf.

Definition at line 31 of file grpcpp/health_check_service_interface.h.

Constructor & Destructor Documentation

◆ ~HealthCheckServiceInterface()

virtual grpc::HealthCheckServiceInterface::~HealthCheckServiceInterface ( )
inlinevirtual

Definition at line 33 of file grpcpp/health_check_service_interface.h.

Member Function Documentation

◆ SetServingStatus() [1/2]

virtual void grpc::HealthCheckServiceInterface::SetServingStatus ( bool  serving)
pure virtual

Apply to all registered service names.

Implemented in grpc::DefaultHealthCheckService.

◆ SetServingStatus() [2/2]

virtual void grpc::HealthCheckServiceInterface::SetServingStatus ( const std::string &  service_name,
bool  serving 
)
pure virtual

Set or change the serving status of the given service_name.

Implemented in grpc::DefaultHealthCheckService.

◆ Shutdown()

virtual void grpc::HealthCheckServiceInterface::Shutdown ( )
inlinevirtual

Set all registered service names to not serving and prevent future state changes.

Reimplemented in grpc::DefaultHealthCheckService.

Definition at line 43 of file grpcpp/health_check_service_interface.h.


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


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