diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_close.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_close.adoc')
| -rw-r--r-- | docs/nng_close.adoc | 48 |
1 files changed, 0 insertions, 48 deletions
diff --git a/docs/nng_close.adoc b/docs/nng_close.adoc deleted file mode 100644 index dfc1b0a6..00000000 --- a/docs/nng_close.adoc +++ /dev/null @@ -1,48 +0,0 @@ -= nng_close(3) -// -// 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_close - close socket - -== SYNOPSIS - -[source, c] ------------ -#include <nng/nng.h> - -int nng_close(nng_socket 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 _s_ is already closed or was never opened. - -== SEE ALSO - -<<nng_setopt#,nng_setopt(3)>>, -<<nng_strerror#,nng_strerror(3)>>, -<<nng#,nng(7)>> |
