aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nn_bind.3compat.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-09-07 10:05:27 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-06 13:53:57 -0700
commit74adece2303ab7c2b05459c7ff24b362e9660068 (patch)
tree61aa056b0511c444cd6d3163bbbff7fb39e1e9e7 /docs/man/nn_bind.3compat.adoc
parentcd77f58b041889f35887736c59b3eaedb60bd84c (diff)
downloadnng-74adece2303ab7c2b05459c7ff24b362e9660068.tar.gz
nng-74adece2303ab7c2b05459c7ff24b362e9660068.tar.bz2
nng-74adece2303ab7c2b05459c7ff24b362e9660068.zip
Remove the documentation for 3compat.
Diffstat (limited to 'docs/man/nn_bind.3compat.adoc')
-rw-r--r--docs/man/nn_bind.3compat.adoc68
1 files changed, 0 insertions, 68 deletions
diff --git a/docs/man/nn_bind.3compat.adoc b/docs/man/nn_bind.3compat.adoc
deleted file mode 100644
index a4ca0043..00000000
--- a/docs/man/nn_bind.3compat.adoc
+++ /dev/null
@@ -1,68 +0,0 @@
-= nn_bind(3compat)
-//
-// Copyright 2020 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
-
-nn_bind - accept connections from remote peers (compatible API)
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nanomsg/nn.h>
-
-int nn_bind(int sock, const char *url)
-----
-
-== DESCRIPTION
-
-The `nn_bind()` function arranges for the socket _sock_ to
-accept connections at the address specified by _url_.
-An identifier for this socket's association with the _url_ is
-returned to the caller on success.
-This identfier can be used with
-xref:nn_shutdown.3compat.adoc[`nn_shutdown()`] to
-remove the association later.
-
-NOTE: This function is provided for API
-xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
-Consider using the relevant xref:libnng.3.adoc[modern API] instead.
-
-NOTE: The bind operation is performed asynchronously, and may not have
-completed before this function returns control to the caller.
-
-IMPORTANT: Only transports supported by legacy _libnanomsg_ may be
-used with this function.
-In particular, only the schemes `tcp://`, `ipc://`, `inproc://`, and `ws://` are
-supported with this function.
-(Use the xref:libnng.3.adoc[modern API] to use other schemes.)
-
-== RETURN VALUES
-
-This function returns a positive identifier on success, and -1 on error.
-
-== ERRORS
-
-[horizontal]
-`EADDRINUSE`:: The address specified by _url_ is already in use.
-`EADDRNOTAVAIL`:: The address specified by _url_ is not available.
-`EBADF`:: The socket _sock_ is not open.
-`EINVAL`:: An invalid _url_ was supplied.
-
-== SEE ALSO
-
-[.text-left]
-xref:nn_connect.3compat.adoc[nn_connect(3compat)],
-xref:nn_errno.3compat.adoc[nn_errno(3compat)],
-xref:nn_shutdown.3compat.adoc[nn_shutdown(3compat)],
-xref:nn_socket.3compat.adoc[nn_socket(3compat)],
-xref:nng_compat.3compat.adoc[nn_compat(3compat)],
-xref:nng.7.adoc[nng(7)]