From b24ef189f1dc9f9bf4889cb420e4645721728036 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 24 Mar 2024 12:53:58 -0700 Subject: Initial swag at mdbook content. This has the nng_a* to nng_c* content converted. Various editorial changes have been made as well. --- docs/reference/src/api/nng_close.md | 45 +++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/reference/src/api/nng_close.md (limited to 'docs/reference/src/api/nng_close.md') diff --git a/docs/reference/src/api/nng_close.md b/docs/reference/src/api/nng_close.md new file mode 100644 index 00000000..486cfe2c --- /dev/null +++ b/docs/reference/src/api/nng_close.md @@ -0,0 +1,45 @@ +# nng_close(3) + +## NAME + +nng_close --- close socket + +## SYNOPSIS + +```c +#include + +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) -- cgit v1.2.3-70-g09d2