socket: rename nng_close to nng_socket_close

5 files changed, 4 insertions, 63 deletions

diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc
index 36117614..9cef1e0f 100644
--- a/docs/man/libnng.3.adoc
+++ b/docs/man/libnng.3.adoc
@@ -47,7 +47,7 @@ The following common functions exist in _libnng_.
 The following functions operate on sockets.
 
 |===
-|xref:nng_close.3.adoc[nng_close()]|close socket
+|xref:nng_socket_close.3.adoc[nng_socket_close()]|close socket
 |xref:nng_dial.3.adoc[nng_dial()]|create and start dialer
 |xref:nng_get.3.adoc[nng_get()]|get socket option
 |xref:nng_listen.3.adoc[nng_listen()]|create and start listener
diff --git a/docs/man/nng_close.3.adoc b/docs/man/nng_close.3.adoc
deleted file mode 100644
index 1867df07..00000000
--- a/docs/man/nng_close.3.adoc
+++ /dev/null
@@ -1,59 +0,0 @@
-= nng_close(3)
-//
-// Copyright 2018 Staysail 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
-// copy of which should be located in the distribution where this
-// file was obtained (LICENSE.txt).  A copy of the license may also be
-// found online at https://opensource.org/licenses/MIT.
-//
-
-== NAME
-
-nng_close - close socket
-
-== SYNOPSIS
-
-[source, 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
-xref:nng_send.3.adoc[`nng_send()`] or similar functions, before calling this
-function.
-
-== RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-[horizontal]
-`NNG_ECLOSED`:: The socket _s_ is already closed or was never opened.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_options.5.adoc[nng_options(5)],
-xref:nng_socket.5.adoc[nng_socket(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_ctx_close.3.adoc b/docs/man/nng_ctx_close.3.adoc
index cfc51bfa..ff43d0b3 100644
--- a/docs/man/nng_ctx_close.3.adoc
+++ b/docs/man/nng_ctx_close.3.adoc
@@ -34,7 +34,7 @@ Threads waiting for operations on the context when this
 call is executed may also return with an `NNG_ECLOSED` result.
 
 NOTE: Closing the socket associated with _ctx_
-(using xref:nng_close.3.adoc[`nng_close()`]) also closes this context.
+(using xref:nng_socket_close.3.adoc[`nng_socket_close()`]) also closes this context.
 
 == RETURN VALUES
 
diff --git a/docs/man/nng_dialer_close.3.adoc b/docs/man/nng_dialer_close.3.adoc
index 6af73ae4..84308b9b 100644
--- a/docs/man/nng_dialer_close.3.adoc
+++ b/docs/man/nng_dialer_close.3.adoc
@@ -48,7 +48,7 @@ This function returns 0 on success, and non-zero otherwise.
 == SEE ALSO
 
 [.text-left]
-xref:nng_close.3.adoc[nng_close(3)],
+xref:nng_socket_close.3.adoc[nng_socket_close(3)],
 xref:nng_dial.3.adoc[nng_dial(3)],
 xref:nng_dialer_create.3.adoc[nng_dialer_create(3)]
 xref:nng_strerror.3.adoc[nng_strerror(3)],
diff --git a/docs/man/nng_listener_close.3.adoc b/docs/man/nng_listener_close.3.adoc
index 239fe26b..b5109f42 100644
--- a/docs/man/nng_listener_close.3.adoc
+++ b/docs/man/nng_listener_close.3.adoc
@@ -48,7 +48,7 @@ This function returns 0 on success, and non-zero otherwise.
 == SEE ALSO
 
 [.text-left]
-xref:nng_close.3.adoc[nng_close(3)],
+xref:nng_socket_close.3.adoc[nng_socket_close(3)],
 xref:nng_listen.3.adoc[nng_listen(3)],
 xref:nng_listener_create.3.adoc[nng_listener_create(3)]
 xref:nng_strerror.3.adoc[nng_strerror(3)],