From ff06de11cf5a953f47d22bd896f3860697c520c8 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 6 Jan 2019 12:02:48 -0800 Subject: fixes #845 TCP public API doc updates --- docs/man/nng_tcp_set_keepalive.3tcp.adoc | 55 -------------------------------- 1 file changed, 55 deletions(-) delete mode 100644 docs/man/nng_tcp_set_keepalive.3tcp.adoc (limited to 'docs/man/nng_tcp_set_keepalive.3tcp.adoc') 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. -// Copyright 2018 Capitar IT Group BV -// -// 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 -#include - -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] -<>, -<>, -<> -- cgit v1.2.3-70-g09d2