aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_close.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2017-10-24 20:40:41 -0700
committerGarrett D'Amore <garrett@damore.org>2017-10-24 20:40:41 -0700
commit5dc7bc188217004cba84d530cbffc18b1df8a331 (patch)
tree2f11f6204e7c4b2a63483dccfaf5f0e768b23b7f /docs/nng_close.adoc
parent4250fc119057eb6a6b534e9c0758488cc5fb034e (diff)
downloadnng-5dc7bc188217004cba84d530cbffc18b1df8a331.tar.gz
nng-5dc7bc188217004cba84d530cbffc18b1df8a331.tar.bz2
nng-5dc7bc188217004cba84d530cbffc18b1df8a331.zip
Various man page fixups, add inproc header.
We added nng_inproc man page, and a header with an explicit registration method for it. We also fixed up the markup on several other pages, and corrected the include statements for nng_zerotier.
Diffstat (limited to 'docs/nng_close.adoc')
-rw-r--r--docs/nng_close.adoc78
1 files changed, 78 insertions, 0 deletions
diff --git a/docs/nng_close.adoc b/docs/nng_close.adoc
new file mode 100644
index 00000000..b767b2ef
--- /dev/null
+++ b/docs/nng_close.adoc
@@ -0,0 +1,78 @@
+nng_close(3)
+============
+:doctype: manpage
+:manmanual: nng
+:mansource: nng
+:manvolnum: 3
+:icons: font
+:source-highlighter: pygments
+:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \
+ Copyright 2017 Capitar IT Group BV <info@capitar.com> \
+ This software 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_close - close a socket
+
+SYNOPSIS
+--------
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int
+nng_close (int s);
+-----------
+
+
+DESCRIPTION
+-----------
+
+The `nng_close()` function closes the supplied socket, 's'. Messages
+that have been submitted for sending may be flushed or delivered,
+depending upon the transport and the setting of the `NNG_OPT_LINGER`
+option.
+
+Further attempts to use the socket after this call returns will result
+in `NNG_EBADF`. Threads waiting for operations on the socket when this
+call is executed may also return with an `NNG_EBADF` result.
+
+
+RETURN VALUES
+-------------
+
+This function returns 0 on success, and non-zero otherwise.
+
+
+ERRORS
+------
+
+`NNG_EBADF`:: The socket is already closed or was never opened.
+
+
+AUTHORS
+-------
+
+link:mailto:garrett@damore.org[Garrett D'Amore]
+
+
+SEE ALSO
+--------
+
+<<nng_setopt#,nng_setopt(3)>>
+<<nng_strerror#,nng_strerror(3)>>
+<<nng#,nng(7)>>
+
+
+COPYRIGHT
+---------
+
+Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] +
+Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV]
+
+This document is supplied under the terms of the
+https://opensource.org/licenses/LICENSE.txt[MIT License].