summaryrefslogtreecommitdiff
path: root/docs/reference/src/sock/nng_close.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-03-30 17:06:11 -0700
committerGarrett D'Amore <garrett@damore.org>2024-03-30 17:06:11 -0700
commit548ab684fa83f3098dea4e7ce09d3f4f1bdb7358 (patch)
tree81eed53d3d59de0a9f6de3dec29544bbe2b7657d /docs/reference/src/sock/nng_close.md
parent83cec91494bba0fe3a0d7340117b3f2af4e40302 (diff)
downloadnng-548ab684fa83f3098dea4e7ce09d3f4f1bdb7358.tar.gz
nng-548ab684fa83f3098dea4e7ce09d3f4f1bdb7358.tar.bz2
nng-548ab684fa83f3098dea4e7ce09d3f4f1bdb7358.zip
sock reorg
Diffstat (limited to 'docs/reference/src/sock/nng_close.md')
-rw-r--r--docs/reference/src/sock/nng_close.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/reference/src/sock/nng_close.md b/docs/reference/src/sock/nng_close.md
new file mode 100644
index 00000000..649316bd
--- /dev/null
+++ b/docs/reference/src/sock/nng_close.md
@@ -0,0 +1,43 @@
+# nng_close
+
+## NAME
+
+nng_close --- close socket
+
+## SYNOPSIS
+
+```c
+#include <nng/nng.h>
+
+int nng_close(nng_socket s);
+```
+
+## DESCRIPTION
+
+The `nng_close()` function closes the [socket][socket] _s_.
+Messages that have been submitted for sending may be flushed or delivered,
+depending upon the [transport][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
+> [`nng_send()`][nng_send] or similar functions, before calling this
+> function.
+
+## RETURN VALUES
+
+This function returns 0 on success, and non-zero otherwise.
+
+## ERRORS
+
+- `NNG_ECLOSED`: The socket _s_ is already closed or was never opened.
+
+{{#include ../refs.md}}