summaryrefslogtreecommitdiff
path: root/docs/man/nng_tcp_set_keepalive.3tcp.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2019-01-06 12:02:48 -0800
committerGarrett D'Amore <garrett@damore.org>2019-01-06 12:12:27 -0800
commitff06de11cf5a953f47d22bd896f3860697c520c8 (patch)
treed8c808c879648cc29dee3e65bded91932be4093a /docs/man/nng_tcp_set_keepalive.3tcp.adoc
parent6d0027fae75e4810d66eb4c5817255ffa517e158 (diff)
downloadnng-ff06de11cf5a953f47d22bd896f3860697c520c8.tar.gz
nng-ff06de11cf5a953f47d22bd896f3860697c520c8.tar.bz2
nng-ff06de11cf5a953f47d22bd896f3860697c520c8.zip
fixes #845 TCP public API doc updates
Diffstat (limited to 'docs/man/nng_tcp_set_keepalive.3tcp.adoc')
-rw-r--r--docs/man/nng_tcp_set_keepalive.3tcp.adoc55
1 files changed, 0 insertions, 55 deletions
diff --git a/docs/man/nng_tcp_set_keepalive.3tcp.adoc b/docs/man/nng_tcp_set_keepalive.3tcp.adoc
deleted file mode 100644
index 8118861a..00000000
--- a/docs/man/nng_tcp_set_keepalive.3tcp.adoc
+++ /dev/null
@@ -1,55 +0,0 @@
-= nng_tcp_set_keepalive(3tcp)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// This document is supplied under the terms of the MIT License, a
-// copy of which should be located in the distribution where this
-// file was obtained (LICENSE.txt). A copy of the license may also be
-// found online at https://opensource.org/licenses/MIT.
-//
-
-== NAME
-
-nng_tcp_set_keepalive - enable or disable TCP keepalives
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-int nng_tcp_set_keepalive(nng_tcp *conn, bool keepalive);
-----
-
-== DESCRIPTION
-
-The `nng_tcp_set_keepalive()` is used to enable or disable ((TCP keepalives))
-on the connection named by _conn_, depending on the value of _keepalive_.
-
-Different platforms have varying degress of support, with different thresholds
-for the interval between keep alive messages, and the duration required for
-a remote peer to be assumed to be offline.
-
-TIP: Keepalives can help keep a connection active, and prevent firewalls or
-other network equipment from discarding routing information as "`stale`",
-but enabling this means interruptions in connectivity will cause a
-connection to fail, which might otherwise be able to recover.
-Keepalives can also prevent a system from going to sleep properly.
-
-== RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-[horizontal]
-`NNG_ECLOSED`:: The connection _conn_ is closed.
-
-== SEE ALSO
-
-[.text-left]
-<<nng_tcp_recv.3tcp#,nng_tcp_recv(3tcp)>>,
-<<nng_strerror.3#,nng_strerror(3)>>,
-<<nng_tcp.5#,nng_tcp(5)>>