summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/xs_getsockopt.txt13
-rw-r--r--doc/xs_setsockopt.txt13
2 files changed, 26 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
------------
diff --git a/doc/xs_setsockopt.txt b/doc/xs_setsockopt.txt
index 6263a26..e9a7050 100644
--- a/doc/xs_setsockopt.txt
+++ b/doc/xs_setsockopt.txt
@@ -348,6 +348,19 @@ Option value unit:: boolean
Default value:: 1 (true)
Applicable socket types:: all, when using TCP transports.
+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
------------