syncing tree with SAMBA_3_0
[Samba.git] / docs / docbook / smbdotconf / tuning / keepalive.xml
blob1320dfab616822bf0aa042892734da37b343b82c
1 <samba:parameter name="keepalive"
2                  context="G"
3                  advanced="1" developer="1"
4                  xmlns:samba="http://samba.org/common">
5 <listitem>
6     <para>The value of the parameter (an integer) represents 
7     the number of seconds between <parameter moreinfo="none">keepalive</parameter> 
8     packets. If this parameter is zero, no keepalive packets will be 
9     sent. Keepalive packets, if sent, allow the server to tell whether 
10     a client is still present and responding.</para>
12     <para>Keepalives should, in general, not be needed if the socket 
13     being used has the SO_KEEPALIVE attribute set on it (see <link linkend="SOCKETOPTIONS">
14     <parameter moreinfo="none">socket options</parameter></link>). 
15     Basically you should only use this option if you strike difficulties.</para>
17     <para>Default: <command moreinfo="none">keepalive = 300</command></para>
19     <para>Example: <command moreinfo="none">keepalive = 600</command></para>
20 </listitem>
21 </samba:parameter>