opensource/grpc-go
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: update keepalive.md to add why (#3993)

Browse Source
This commit is contained in:
Menghan Li
2020-10-29 10:15:45 -07:00
committed by GitHub
parent 15a78f1930
commit fe98b4c668
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/keepalive.md
View File

@ -8,6 +8,17 @@ activity on the connection.
For how to configure keepalive, see For how to configure keepalive, see
https://godoc.org/google.golang.org/grpc/keepalive for the options. https://godoc.org/google.golang.org/grpc/keepalive for the options.
## Why do I need this?
Keepalive can be useful to detect TCP level connection failures. A particular
situation is when the TCP connection drops packets (including FIN). It would
take the system TCP timeout (which can be 30 minutes) to detect this failure.
Keepalive would allow gRPC to detect this failure much sooner.
Another usage is (as the name suggests) to keep the connection alive. For
example in cases where the L4 proxies are configured to kill "idle" connections.
Sending pings would make the connections not "idle".
## What should I set? ## What should I set?
It should be sufficient for most users to set [client It should be sufficient for most users to set [client