Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit e351593

Browse files
committed
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.
1 parent 7c49bf9 commit e351593

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

doc/src/sgml/libpq.sgml

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.309 2010/06/23 21:54:13 rhaas Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.310 2010/06/25 17:08:09 rhaas Exp $ -->
22

33
<chapter id="libpq">
44
<title><application>libpq</application> - C Library</title>
@@ -284,10 +284,10 @@
284284
<term><literal>keepalives</literal></term>
285285
<listitem>
286286
<para>
287-
Controls whether TCP keepalives are used. The default value is 1,
288-
meaning on, but you can change this to 0, meaning off, if keepalives
289-
are not wanted. This parameter is ignored for connections made via
290-
a Unix-domain socket.
287+
Controls whether client-side TCP keepalives are used. The default
288+
value is 1, meaning on, but you can change this to 0, meaning off,
289+
if keepalives are not wanted. This parameter is ignored for
290+
connections made via a Unix-domain socket.
291291
</para>
292292
</listitem>
293293
</varlistentry>
@@ -296,11 +296,12 @@
296296
<term><literal>keepalives_idle</literal></term>
297297
<listitem>
298298
<para>
299-
On systems that support the <symbol>TCP_KEEPIDLE</symbol> socket
300-
option, specifies the number of seconds between sending keepalives
301-
on an otherwise idle connection. A value of zero uses the system
302-
default. This parameter is ignored for connections made via a
303-
Unix-domain socket, or if keepalives are disabled.
299+
Controls the number of seconds of inactivity after which TCP should
300+
send a keepalive message to the server. A value of zero uses the
301+
system default. This parameter is ignored if the
302+
<symbol>TCP_KEEPIDLE</> socket option is not supported, for
303+
connections made via a Unix-domain socket, or if keepalives are
304+
disabled.
304305
</para>
305306
</listitem>
306307
</varlistentry>
@@ -309,11 +310,12 @@
309310
<term><literal>keepalives_interval</literal></term>
310311
<listitem>
311312
<para>
312-
On systems that support the <symbol>TCP_KEEPINTVL</symbol> socket
313-
option, specifies how long, in seconds, to wait for a response to a
314-
keepalive before retransmitting. A value of zero uses the system
315-
default. This parameter is ignored for connections made via a
316-
Unix-domain socket, or if keepalives are disabled.
313+
Controls the number of seconds after which a TCP keepalive message
314+
that is not acknowledged by the server should be retransmitted. A
315+
value of zero uses the system default. This parameter is ignored if
316+
the <symbol>TCP_KEEPINTVL</> socket option is not supported, for
317+
connections made via a Unix-domain socket, or if keepalives are
318+
disabled.
317319
</para>
318320
</listitem>
319321
</varlistentry>
@@ -322,11 +324,12 @@
322324
<term><literal>keepalives_count</literal></term>
323325
<listitem>
324326
<para>
325-
On systems that support the <symbol>TCP_KEEPCNT</symbol> socket
326-
option, specifies how many keepalives can be lost before the
327-
connection is considered dead. A value of zero uses the system
328-
default. This parameter is ignored for connections made via a
329-
Unix-domain socket, or if keepalives are disabled.
327+
Controls the number of TCP keepalives that can be lost before the
328+
client's connection to the server is considered dead. A value of
329+
zero uses the system default. This parameter is ignored if the
330+
<symbol>TCP_KEEPCNT</> socket option is not supported, for
331+
connections made via a Unix-domain socket, or if keepalives are
332+
disabled.
330333
</para>
331334
</listitem>
332335
</varlistentry>

0 commit comments

Comments
 (0)