aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nn_term.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_term.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_term.3compat.adoc')
-rw-r--r--docs/man/nn_term.3compat.adoc59
1 files changed, 0 insertions, 59 deletions
diff --git a/docs/man/nn_term.3compat.adoc b/docs/man/nn_term.3compat.adoc
deleted file mode 100644
index 79b6a1e3..00000000
--- a/docs/man/nn_term.3compat.adoc
+++ /dev/null
@@ -1,59 +0,0 @@
-= nn_term(3compat)
-//
-// 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
-
-nn_term - terminate library (compatible API)
-
-== SYNOPSIS
-
-[source,c]
-----
-#include <nanomsg/nn.h>
-
-void nn_term(void);
-----
-
-== DESCRIPTION
-
-The `nn_term()` function closes any open sockets, and frees all resources
-allocated by the library.
-Any operations that are currently in progress will be terminated, and will
-fail with error `EBADF` or `ETERM`.
-
-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.
-
-IMPORTANT: This function is not thread-safe, and is not suitable for use
-in library calls.
-The intended purpose of this is to clean up at application termination; for
-example by registering this function with `atexit()`.
-This can help prevent false leak reports caused when memory checkers notice
-global resources allocated by the library.
-Libraries should never use this function, but should explicitly close their
-own sockets directly.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nn_errno.3compat.adoc[nn_errno(3compat)],
-xref:nn_socket.3compat.adoc[nn_socket(3compat)],
-xref:nng_compat.3compat.adoc[nng_compat(3compat)],
-xref:nng.7.adoc[nng(7)]