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

source code of include/grpcpp/health_check_service_interface_impl.h