From 5dc7bc188217004cba84d530cbffc18b1df8a331 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Tue, 24 Oct 2017 20:40:41 -0700 Subject: 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. --- docs/nng_close.adoc | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 docs/nng_close.adoc (limited to 'docs/nng_close.adoc') 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 \ + Copyright 2017 Capitar IT Group BV \ + 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 + +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 +-------- + +<> +<> +<> + + +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]. -- cgit v1.2.3-70-g09d2