GRPC C++  1.39.1
health_check_service_interface.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2016 gRPC authors.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18 
19 #ifndef GRPCPP_HEALTH_CHECK_SERVICE_INTERFACE_H
20 #define GRPCPP_HEALTH_CHECK_SERVICE_INTERFACE_H
21 
22 #include <grpcpp/support/config.h>
23 
24 namespace grpc {
25 
27  "grpc.health_check_service_interface";
28 
32  public:
34 
36  virtual void SetServingStatus(const std::string& service_name,
37  bool serving) = 0;
39  virtual void SetServingStatus(bool serving) = 0;
40 
43  virtual void Shutdown() {}
44 };
45 
51 
55 
56 } // namespace grpc
57 
58 #endif // GRPCPP_HEALTH_CHECK_SERVICE_INTERFACE_H
The gRPC server uses this interface to expose the health checking service without depending on protob...
Definition: health_check_service_interface.h:31
virtual void SetServingStatus(const std::string &service_name, bool serving)=0
Set or change the serving status of the given service_name.
virtual void SetServingStatus(bool serving)=0
Apply to all registered service names.
virtual void Shutdown()
Set all registered service names to not serving and prevent future state changes.
Definition: health_check_service_interface.h:43
virtual ~HealthCheckServiceInterface()
Definition: health_check_service_interface.h:33
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm.h:33
const char kHealthCheckServiceInterfaceArg[]
Definition: health_check_service_interface.h:26
void EnableDefaultHealthCheckService(bool enable)
Enable/disable the default health checking service.
bool DefaultHealthCheckServiceEnabled()
Returns whether the default health checking service is enabled.