summaryrefslogtreecommitdiff
path: root/man/v1.7.2/nn_term.3compat.html
diff options
context:
space:
mode:
authorStaysail Systems, Inc <info@staysail.tech>2024-02-22 01:03:04 -0800
committerGarrett D'Amore <garrett@damore.org>2024-02-22 01:04:43 -0800
commitd7a4a138ba371e8a969a7fde8219c88870d288fc (patch)
tree99a2f036788e66570b38d2b20923945bc941946a /man/v1.7.2/nn_term.3compat.html
parente96b0be664b5c67cc13898864d46fdb5956de1b1 (diff)
downloadnng-d7a4a138ba371e8a969a7fde8219c88870d288fc.tar.gz
nng-d7a4a138ba371e8a969a7fde8219c88870d288fc.tar.bz2
nng-d7a4a138ba371e8a969a7fde8219c88870d288fc.zip
Manual page updates for v1.7.2
Diffstat (limited to 'man/v1.7.2/nn_term.3compat.html')
-rw-r--r--man/v1.7.2/nn_term.3compat.html97
1 files changed, 97 insertions, 0 deletions
diff --git a/man/v1.7.2/nn_term.3compat.html b/man/v1.7.2/nn_term.3compat.html
new file mode 100644
index 00000000..6d716cca
--- /dev/null
+++ b/man/v1.7.2/nn_term.3compat.html
@@ -0,0 +1,97 @@
+---
+version: v1.7.2
+layout: manpage_v2
+title: nn_term(3compat)
+---
+<h1>nn_term(3compat)</h1>
+<div class="sect1">
+<h2 id="_name">NAME</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>nn_term - terminate library (compatible API)</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_synopsis">SYNOPSIS</h2>
+<div class="sectionbody">
+<div class="listingblock">
+<div class="content">
+<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-cp">#include</span><span class="tok-w"> </span><span class="tok-cpf">&lt;nanomsg/nn.h&gt;</span>
+
+<span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-nf">nn_term</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_description">DESCRIPTION</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The <code>nn_term()</code> 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 <code>EBADF</code> or <code>ETERM</code>.</p>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+This function is provided for API
+<a href="nng_compat.3compat.html">compatibility</a> with legacy <em>libnanomsg</em>.
+Consider using the relevant <a href="libnng.3.html">modern API</a> instead.
+</td>
+</tr>
+</table>
+</div>
+<div class="admonitionblock important">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-important" title="Important"></i>
+</td>
+<td class="content">
+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 <code>atexit()</code>.
+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.
+</td>
+</tr>
+</table>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_return_values">RETURN VALUES</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>None.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_errors">ERRORS</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>None.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_see_also">SEE ALSO</h2>
+<div class="sectionbody">
+<div class="paragraph text-left">
+<p><a href="nn_errno.3compat.html">nn_errno(3compat)</a>,
+<a href="nn_socket.3compat.html">nn_socket(3compat)</a>,
+<a href="nng_compat.3compat.html">nng_compat(3compat)</a>,
+<a href="nng.7.html">nng(7)</a></p>
+</div>
+</div>
+</div>