GRPC C++  1.4.0
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
health_check_service_interface.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2016, Google Inc.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above
13  * copyright notice, this list of conditions and the following disclaimer
14  * in the documentation and/or other materials provided with the
15  * distribution.
16  * * Neither the name of Google Inc. nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  */
33 
34 #ifndef GRPCXX_HEALTH_CHECK_SERVICE_INTERFACE_H
35 #define GRPCXX_HEALTH_CHECK_SERVICE_INTERFACE_H
36 
37 #include <grpc++/support/config.h>
38 
39 namespace grpc {
40 
42  "grpc.health_check_service_interface";
43 
47  public:
49 
51  virtual void SetServingStatus(const grpc::string& service_name,
52  bool serving) = 0;
54  virtual void SetServingStatus(bool serving) = 0;
55 };
56 
61 void EnableDefaultHealthCheckService(bool enable);
62 
66 
67 } // namespace grpc
68 
69 #endif // GRPCXX_HEALTH_CHECK_SERVICE_INTERFACE_H
virtual void SetServingStatus(const grpc::string &service_name, bool serving)=0
Set or change the serving status of the given service_name.
std::string string
Definition: config.h:50
bool DefaultHealthCheckServiceEnabled()
Returns whether the default health checking service is enabled.
The gRPC server uses this interface to expose the health checking service without depending on protob...
Definition: health_check_service_interface.h:46
const char kHealthCheckServiceInterfaceArg[]
Definition: health_check_service_interface.h:41
virtual ~HealthCheckServiceInterface()
Definition: health_check_service_interface.h:48
void EnableDefaultHealthCheckService(bool enable)
Enable/disable the default health checking service.