diff options
author | Mark D. Roth <roth@google.com> | 2018-08-28 08:51:52 -0700 |
---|---|---|
committer | Mark D. Roth <roth@google.com> | 2018-08-28 08:51:52 -0700 |
commit | 99ce3e19afeb445245a8c2a341196ca3356501a4 (patch) | |
tree | 16710a42f0c6e65f3e6fc608237ae7a90f9daffa /src/proto | |
parent | af89e8c00e796f3398b09b7daed693df2b14da56 (diff) |
Implement Watch method in health check service.
Diffstat (limited to 'src/proto')
-rw-r--r-- | src/proto/grpc/health/v1/health.proto | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/src/proto/grpc/health/v1/health.proto b/src/proto/grpc/health/v1/health.proto index 4b4677b8a4..38843ff1e7 100644 --- a/src/proto/grpc/health/v1/health.proto +++ b/src/proto/grpc/health/v1/health.proto @@ -34,10 +34,30 @@ message HealthCheckResponse { UNKNOWN = 0; SERVING = 1; NOT_SERVING = 2; + SERVICE_UNKNOWN = 3; // Used only by the Watch method. } ServingStatus status = 1; } service Health { + // If the requested service is unknown, the call will fail with status + // NOT_FOUND. rpc Check(HealthCheckRequest) returns (HealthCheckResponse); + + // Performs a watch for the serving status of the requested service. + // The server will immediately send back a message indicating the current + // serving status. It will then subsequently send a new message whenever + // the service's serving status changes. + // + // If the requested service is unknown when the call is received, the + // server will send a message setting the serving status to + // SERVICE_UNKNOWN but will *not* terminate the call. If at some + // future point, the serving status of the service becomes known, the + // server will send a new message with the service's serving status. + // + // If the call terminates with status UNIMPLEMENTED, then clients + // should assume this method is not supported and should not retry the + // call. If the call terminates with any other status (including OK), + // clients should retry the call with appropriate exponential backoff. + rpc Watch(HealthCheckRequest) returns (stream HealthCheckResponse); } |