aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/tcp.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/src/tcp.rst b/docs/src/tcp.rst
index bcb163ea..3cc8efaa 100644
--- a/docs/src/tcp.rst
+++ b/docs/src/tcp.rst
@@ -60,6 +60,11 @@ API
Enable / disable TCP keep-alive. `delay` is the initial delay in seconds,
ignored when `enable` is zero.
+ After `delay` has been reached, 10 successive probes, each spaced 1 second
+ from the previous one, will still happen. If the connection is still lost
+ at the end of this procedure, then the handle is destroyed with a
+ ``UV_ETIMEDOUT`` error passed to the corresponding callback.
+
.. c:function:: int uv_tcp_simultaneous_accepts(uv_tcp_t* handle, int enable)
Enable / disable simultaneous asynchronous accept requests that are