Skip to content

Commit 5b336b5

Browse files
authored
Merge pull request grpc#19104 from sanjaypujare/add_watch_to_hc
Document the Watch() method that got added to health/v1/health.proto
2 parents a30c1d0 + 18a9e00 commit 5b336b5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/health-checking.md

+7
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ message HealthCheckResponse {
4343
4444
service Health {
4545
rpc Check(HealthCheckRequest) returns (HealthCheckResponse);
46+
47+
rpc Watch(HealthCheckRequest) returns (stream HealthCheckResponse);
4648
}
4749
```
4850

@@ -68,3 +70,8 @@ matching semantics that both the client and server agree upon.
6870
A client can declare the server as unhealthy if the rpc is not finished after
6971
some amount of time. The client should be able to handle the case where server
7072
does not have the Health service.
73+
74+
A client can call the `Watch` method to perform a streaming health-check.
75+
The server will immediately send back a message indicating the current
76+
serving status. It will then subsequently send a new message whenever
77+
the service's serving status changes.

0 commit comments

Comments
 (0)