Commit e3515939 authored by Robert Haas's avatar Robert Haas

Rewrite docs for new libpq keepalive parameters.

The revised documentation makes it more clear that these are client-side
parameters, rather than server side parameters.  It also puts the main
point of each parameter first, and consolidates the conditions under which
it might be ignored in a single list at the end.
parent 7c49bf9d
<!-- $PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.309 2010/06/23 21:54:13 rhaas Exp $ --> <!-- $PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.310 2010/06/25 17:08:09 rhaas Exp $ -->
<chapter id="libpq"> <chapter id="libpq">
<title><application>libpq</application> - C Library</title> <title><application>libpq</application> - C Library</title>
...@@ -284,10 +284,10 @@ ...@@ -284,10 +284,10 @@
<term><literal>keepalives</literal></term> <term><literal>keepalives</literal></term>
<listitem> <listitem>
<para> <para>
Controls whether TCP keepalives are used. The default value is 1, Controls whether client-side TCP keepalives are used. The default
meaning on, but you can change this to 0, meaning off, if keepalives value is 1, meaning on, but you can change this to 0, meaning off,
are not wanted. This parameter is ignored for connections made via if keepalives are not wanted. This parameter is ignored for
a Unix-domain socket. connections made via a Unix-domain socket.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -296,11 +296,12 @@ ...@@ -296,11 +296,12 @@
<term><literal>keepalives_idle</literal></term> <term><literal>keepalives_idle</literal></term>
<listitem> <listitem>
<para> <para>
On systems that support the <symbol>TCP_KEEPIDLE</symbol> socket Controls the number of seconds of inactivity after which TCP should
option, specifies the number of seconds between sending keepalives send a keepalive message to the server. A value of zero uses the
on an otherwise idle connection. A value of zero uses the system system default. This parameter is ignored if the
default. This parameter is ignored for connections made via a <symbol>TCP_KEEPIDLE</> socket option is not supported, for
Unix-domain socket, or if keepalives are disabled. connections made via a Unix-domain socket, or if keepalives are
disabled.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -309,11 +310,12 @@ ...@@ -309,11 +310,12 @@
<term><literal>keepalives_interval</literal></term> <term><literal>keepalives_interval</literal></term>
<listitem> <listitem>
<para> <para>
On systems that support the <symbol>TCP_KEEPINTVL</symbol> socket Controls the number of seconds after which a TCP keepalive message
option, specifies how long, in seconds, to wait for a response to a that is not acknowledged by the server should be retransmitted. A
keepalive before retransmitting. A value of zero uses the system value of zero uses the system default. This parameter is ignored if
default. This parameter is ignored for connections made via a the <symbol>TCP_KEEPINTVL</> socket option is not supported, for
Unix-domain socket, or if keepalives are disabled. connections made via a Unix-domain socket, or if keepalives are
disabled.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -322,11 +324,12 @@ ...@@ -322,11 +324,12 @@
<term><literal>keepalives_count</literal></term> <term><literal>keepalives_count</literal></term>
<listitem> <listitem>
<para> <para>
On systems that support the <symbol>TCP_KEEPCNT</symbol> socket Controls the number of TCP keepalives that can be lost before the
option, specifies how many keepalives can be lost before the client's connection to the server is considered dead. A value of
connection is considered dead. A value of zero uses the system zero uses the system default. This parameter is ignored if the
default. This parameter is ignored for connections made via a <symbol>TCP_KEEPCNT</> socket option is not supported, for
Unix-domain socket, or if keepalives are disabled. connections made via a Unix-domain socket, or if keepalives are
disabled.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment