fixes #680 Public TCP API

1 files changed, 60 insertions, 0 deletions

diff --git a/docs/man/nng_tcp_close.3tcp.adoc b/docs/man/nng_tcp_close.3tcp.adoc
new file mode 100644
index 00000000..6428501c
--- /dev/null
+++ b/docs/man/nng_tcp_close.3tcp.adoc
@@ -0,0 +1,60 @@
+= nng_tcp_close(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_close - close TCP connection
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+#include <nng/supplemental/tcp/tcp.h>
+
+void nng_tcp_close(nng_tcp *conn);
+----
+
+== DESCRIPTION
+
+The `nng_tcp_close()` function closes the supplied TCP connection, _conn_.
+
+If any operations are pending (such as `<<nng_tcp_send.3tcp#,nng_tcp_send()>>`
+or `<<nng_tcp_recv.3tcp#,nng_tcp_recv()>>` they will be terminated with
+an `NNG_ECLOSED` error condition.
+Also, any new operations will fail with `NNG_ECLOSED` after the connection
+is closed.
+
+NOTE: Closing the connection while data is in transmission will likely
+lead to loss of that data.
+There is no automatic linger or flush to ensure that the socket send buffers
+have completely transmitted.
+
+NOTE: Closing the connection does not free the resources associated with it.
+Once it is certain that no more operations are pending on the connection,
+it should be freed with `<<nng_tcp_free.3tcp#,nng_tcp_free()>>`.
+
+== RETURN VALUES
+
+None.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+[.text-left]
+<<nng_strerror.3#,nng_strerror(3)>>,
+<<nng_tcp_free.3tcp#,nng_tcp_free(3tcp)>>,
+<<nng_tcp_recv.3tcp#,nng_tcp_recv(3tcp)>>,
+<<nng_tcp_send.3tcp#,nng_tcp_send(3tcp)>>,
+<<nng_tcp.5#,nng_tcp(5)>>