summaryrefslogtreecommitdiff
path: root/docs/reference/src/api/nng_close.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-03-25 21:11:43 -0700
committerGarrett D'Amore <garrett@damore.org>2024-03-25 21:11:43 -0700
commit9d71bbc9f67478ccc28bf6ea9cb1617e8293be94 (patch)
tree5f8da683d30f024b705df82754be3a17c6ad6327 /docs/reference/src/api/nng_close.md
parent331bd5a7c360083f245fe6c82afa38dd05c4a9c9 (diff)
downloadnng-9d71bbc9f67478ccc28bf6ea9cb1617e8293be94.tar.gz
nng-9d71bbc9f67478ccc28bf6ea9cb1617e8293be94.tar.bz2
nng-9d71bbc9f67478ccc28bf6ea9cb1617e8293be94.zip
More updates
Diffstat (limited to 'docs/reference/src/api/nng_close.md')
-rw-r--r--docs/reference/src/api/nng_close.md45
1 files changed, 0 insertions, 45 deletions
diff --git a/docs/reference/src/api/nng_close.md b/docs/reference/src/api/nng_close.md
deleted file mode 100644
index 486cfe2c..00000000
--- a/docs/reference/src/api/nng_close.md
+++ /dev/null
@@ -1,45 +0,0 @@
-# nng_close(3)
-
-## NAME
-
-nng_close --- close socket
-
-## SYNOPSIS
-
-```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
-> [`nng_send()`](nng_send.md) 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.
-
-## SEE ALSO
-
-[nng_socket](nng_socket.md)