diff options
| author | Martin Sustrik <sustrik@250bpm.com> | 2012-03-28 09:20:38 +0200 |
|---|---|---|
| committer | Martin Sustrik <sustrik@250bpm.com> | 2012-03-28 09:20:38 +0200 |
| commit | 9c7e081f51063b6cdb4674f4d2e6c4eab502a327 (patch) | |
| tree | 25c46150eee45e6ad327b2e5e92fd8802fff72a5 /doc/xs_getsockopt.txt | |
| parent | e440e55d45a571c221af9c1657a2006597a6b88f (diff) | |
XS_KEEPALIVE options added
This option allows to turn on TCP keepalives on the underlying connections.
Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
Diffstat (limited to 'doc/xs_getsockopt.txt')
| -rw-r--r-- | doc/xs_getsockopt.txt | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/xs_getsockopt.txt b/doc/xs_getsockopt.txt index 5a09453..c113f16 100644 --- a/doc/xs_getsockopt.txt +++ b/doc/xs_getsockopt.txt @@ -390,6 +390,19 @@ Option value unit:: N/A (flags) Default value:: N/A Applicable socket types:: all +XS_KEEPALIVE: Use TCP keepalives +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When set to `1` TCP keepalives are enabled. This option can be used to prevent +the infrastructure (VPNs and similar) to terminate connections with no activity. +The keepalive period as such is normally a global OS setting. + +[horizontal] +Option value type:: int +Option value unit:: boolean +Default value:: 0 (false) +Applicable socket types:: all, when using TCP transports. + RETURN VALUE ------------ |