From 6f8944a96a5acd509014caae4e57dafbba51e126 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Sat, 30 Mar 2024 22:14:33 -0700
Subject: finished proto open pages

---
 docs/reference/src/compat/nn_term.3compat.adoc | 59 ++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 docs/reference/src/compat/nn_term.3compat.adoc

(limited to 'docs/reference/src/compat/nn_term.3compat.adoc')

diff --git a/docs/reference/src/compat/nn_term.3compat.adoc b/docs/reference/src/compat/nn_term.3compat.adoc
new file mode 100644
index 00000000..79b6a1e3
--- /dev/null
+++ b/docs/reference/src/compat/nn_term.3compat.adoc
@@ -0,0 +1,59 @@
+= 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)]
-- 
cgit v1.2.3-70-g09d2

