diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-03-30 22:14:33 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-03-30 22:14:33 -0700 |
| commit | 6f8944a96a5acd509014caae4e57dafbba51e126 (patch) | |
| tree | cc409dd3522d2e949227525c2f88a453bcf84b79 /docs/reference/src/compat/nn_close.3compat.adoc | |
| parent | a30600629f4e885fee4acf25f5cd7c663ddc7b04 (diff) | |
| download | nng-6f8944a96a5acd509014caae4e57dafbba51e126.tar.gz nng-6f8944a96a5acd509014caae4e57dafbba51e126.tar.bz2 nng-6f8944a96a5acd509014caae4e57dafbba51e126.zip | |
finished proto open pages
Diffstat (limited to 'docs/reference/src/compat/nn_close.3compat.adoc')
| -rw-r--r-- | docs/reference/src/compat/nn_close.3compat.adoc | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/reference/src/compat/nn_close.3compat.adoc b/docs/reference/src/compat/nn_close.3compat.adoc new file mode 100644 index 00000000..1970b57d --- /dev/null +++ b/docs/reference/src/compat/nn_close.3compat.adoc @@ -0,0 +1,51 @@ += nn_close(3compat) +// +// 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 + +nn_close - close socket (compatible API) + +== SYNOPSIS + +[source,c] +---- +#include <nanomsg/nn.h> + +int nn_close(int sock); +---- + +== DESCRIPTION + +The `nn_close()` function closes the socket _sock_. +Any operations that are currently in progress will be terminated, and will +fail with error `EBADF`. + +NOTE: This function is provided for API +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. + +== RETURN VALUES + +This function returns zero on success, and -1 on failure. + +== ERRORS + +[horizontal] +`EBADF`:: The socket is not open. +`ETERM`:: The library is shutting down. + +== SEE ALSO + +[.text-left] +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] |
