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
24namespace grpc {
25
26const char kHealthCheckServiceInterfaceArg[] =
27 "grpc.health_check_service_interface";
28
29/// The gRPC server uses this interface to expose the health checking service
30/// without depending on protobuf.
31class HealthCheckServiceInterface {
32 public:
33 virtual ~HealthCheckServiceInterface() {}
34
35 /// Set or change the serving status of the given \a service_name.
36 virtual void SetServingStatus(const std::string& service_name,
37 bool serving) = 0;
38 /// Apply to all registered service names.
39 virtual void SetServingStatus(bool serving) = 0;
40
41 /// Set all registered service names to not serving and prevent future
42 /// state changes.
43 virtual void Shutdown() {}
44};
45
46/// Enable/disable the default health checking service. This applies to all C++
47/// servers created afterwards. For each server, user can override the default
48/// with a HealthCheckServiceServerBuilderOption.
49/// NOT thread safe.
50void EnableDefaultHealthCheckService(bool enable);
51
52/// Returns whether the default health checking service is enabled.
53/// NOT thread safe.
54bool DefaultHealthCheckServiceEnabled();
55
56} // namespace grpc
57
58#endif // GRPCPP_HEALTH_CHECK_SERVICE_INTERFACE_H
59

source code of include/grpcpp/health_check_service_interface.h