aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_close.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-12-31 13:26:44 -0800
committerGarrett D'Amore <garrett@damore.org>2024-12-31 13:26:44 -0800
commitb0874b1dad787c32093a3ff81311e2d638dc6538 (patch)
treecde1005cef02954893fe2d9786d248930f857200 /docs/man/nng_close.3.adoc
parent2a4a14646f95b21cbc8f9b5bef8d76cd0fe04fec (diff)
downloadnng-b0874b1dad787c32093a3ff81311e2d638dc6538.tar.gz
nng-b0874b1dad787c32093a3ff81311e2d638dc6538.tar.bz2
nng-b0874b1dad787c32093a3ff81311e2d638dc6538.zip
socket: rename nng_close to nng_socket_close
Diffstat (limited to 'docs/man/nng_close.3.adoc')
-rw-r--r--docs/man/nng_close.3.adoc59
1 files changed, 0 insertions, 59 deletions
diff --git a/docs/man/nng_close.3.adoc b/docs/man/nng_close.3.adoc
deleted file mode 100644
index 1867df07..00000000
--- a/docs/man/nng_close.3.adoc
+++ /dev/null
@@ -1,59 +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.
-
-Further attempts to use the socket after this call returns will result
-in `NNG_ECLOSED`.
-Threads waiting for operations on the socket when this
-call is executed may also return with an `NNG_ECLOSED` result.
-
-NOTE: Closing the socket 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.
-It is recommended to wait a brief period after calling
-xref:nng_send.3.adoc[`nng_send()`] or similar functions, before calling this
-function.
-
-== RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-[horizontal]
-`NNG_ECLOSED`:: The socket _s_ is already closed or was never opened.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_options.5.adoc[nng_options(5)],
-xref:nng_socket.5.adoc[nng_socket(5)],
-xref:nng.7.adoc[nng(7)]