From 8c529c4143ce06b4c72fca1aa593e32e62fdbe18 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 3 Jan 2025 08:59:47 -0800 Subject: stable: add nng_socket_close to aid transition to 2.0 --- docs/man/nng_close.3.adoc | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'docs') 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. +// Copyright 2025 Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -20,14 +20,19 @@ nng_close - close socket #include 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 -- cgit v1.2.3-70-g09d2