diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/nng_close.3.adoc | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/man/nng_close.3.adoc b/docs/man/nng_close.3.adoc index 1867df07..827bf929 100644 --- a/docs/man/nng_close.3.adoc +++ b/docs/man/nng_close.3.adoc @@ -1,6 +1,6 @@ = nng_close(3) // -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2025 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 @@ -20,14 +20,19 @@ nng_close - close socket #include <nng/nng.h> int nng_close(nng_socket s); +int nng_socket_close(nng_socket s); ---- == DESCRIPTION -The `nng_close()` function closes the supplied socket, _s_. +The `nng_socket_close()` function closes the supplied socket, _s_. Messages that have been submitted for sending may be flushed or delivered, depending upon the transport. +The `nng_close()` function also does this, and is the old name for this +function. The `nng_close()` function is considered deprecated and may +be removed in the next major release. + Further attempts to use the socket after this call returns will result in `NNG_ECLOSED`. Threads waiting for operations on the socket when this |