summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/tuning/keepalive.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/smbdotconf/tuning/keepalive.xml')
-rw-r--r--docs/smbdotconf/tuning/keepalive.xml21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/smbdotconf/tuning/keepalive.xml b/docs/smbdotconf/tuning/keepalive.xml
new file mode 100644
index 0000000000..dd0c1ca51d
--- /dev/null
+++ b/docs/smbdotconf/tuning/keepalive.xml
@@ -0,0 +1,21 @@
+<samba:parameter name="keepalive"
+ context="G"
+ type="integer"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<description>
+ <para>The value of the parameter (an integer) represents
+ the number of seconds between <parameter moreinfo="none">keepalive</parameter>
+ packets. If this parameter is zero, no keepalive packets will be
+ sent. Keepalive packets, if sent, allow the server to tell whether
+ a client is still present and responding.</para>
+
+ <para>Keepalives should, in general, not be needed if the socket
+ being used has the SO_KEEPALIVE attribute set on it (see <link linkend="SOCKETOPTIONS">
+ <parameter moreinfo="none">socket options</parameter></link>).
+Basically you should only use this option if you strike difficulties.</para>
+</description>
+
+<value type="default">300</value>
+<value type="example">600</value>
+</samba:parameter>