From 548ab684fa83f3098dea4e7ce09d3f4f1bdb7358 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 30 Mar 2024 17:06:11 -0700 Subject: sock reorg --- docs/reference/src/sock/nng_close.md | 43 ++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/reference/src/sock/nng_close.md (limited to 'docs/reference/src/sock/nng_close.md') 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 + +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}} -- cgit v1.2.3-70-g09d2