diff options
| author | Staysail Systems, Inc <info@staysail.tech> | 2024-01-07 12:27:42 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-01-07 12:28:20 -0800 |
| commit | 1d60c74482d73528f70da65b8802269ea6b35877 (patch) | |
| tree | 4eff69740d57ea9a2b7d14de3a4d71eaf218e345 /man/v1.7.1/nn_bind.3compat.html | |
| parent | 968b474ccac63b36b54e4abc1122e20e93afaab4 (diff) | |
| download | nng-1d60c74482d73528f70da65b8802269ea6b35877.tar.gz nng-1d60c74482d73528f70da65b8802269ea6b35877.tar.bz2 nng-1d60c74482d73528f70da65b8802269ea6b35877.zip | |
Manual page updates for v1.7.1
Diffstat (limited to 'man/v1.7.1/nn_bind.3compat.html')
| -rw-r--r-- | man/v1.7.1/nn_bind.3compat.html | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/man/v1.7.1/nn_bind.3compat.html b/man/v1.7.1/nn_bind.3compat.html new file mode 100644 index 00000000..88211330 --- /dev/null +++ b/man/v1.7.1/nn_bind.3compat.html @@ -0,0 +1,145 @@ +--- +version: v1.7.1 +layout: manpage_v2 +title: nn_bind(3compat) +--- +<h1>nn_bind(3compat)</h1> +<div class="sect1"> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>nn_bind - accept connections from remote peers (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 class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/nn.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nn_bind</span><span class="tok-p">(</span><span class="tok-kt">int</span> <span class="tok-n">sock</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">url</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_bind()</code> function arranges for the socket <em>sock</em> to +accept connections at the address specified by <em>url</em>. +An identifier for this socket’s association with the <em>url</em> is +returned to the caller on success. +This identfier can be used with +<a href="nn_shutdown.3compat.html"><code>nn_shutdown()</code></a> to +remove the association later.</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 note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +The bind operation is performed asynchronously, and may not have +completed before this function returns control to the caller. +</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"> +Only transports supported by legacy <em>libnanomsg</em> may be +used with this function. +In particular, only the schemes <code>tcp://</code>, <code>ipc://</code>, <code>inproc://</code>, and <code>ws://</code> are +supported with this function. +(Use the <a href="libnng.3.html">modern API</a> to use other schemes.) +</td> +</tr> +</table> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_return_values">RETURN VALUES</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>This function returns a positive identifier on success, and -1 on error.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_errors">ERRORS</h2> +<div class="sectionbody"> +<div class="hdlist"> +<table> +<tr> +<td class="hdlist1"> +<code>EADDRINUSE</code> +</td> +<td class="hdlist2"> +<p>The address specified by <em>url</em> is already in use.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>EADDRNOTAVAIL</code> +</td> +<td class="hdlist2"> +<p>The address specified by <em>url</em> is not available.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>EBADF</code> +</td> +<td class="hdlist2"> +<p>The socket <em>sock</em> is not open.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>EINVAL</code> +</td> +<td class="hdlist2"> +<p>An invalid <em>url</em> was supplied.</p> +</td> +</tr> +</table> +</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_connect.3compat.html">nn_connect(3compat)</a>, +<a href="nn_errno.3compat.html">nn_errno(3compat)</a>, +<a href="nn_shutdown.3compat.html">nn_shutdown(3compat)</a>, +<a href="nn_socket.3compat.html">nn_socket(3compat)</a>, +<a href="nng_compat.3compat.html">nn_compat(3compat)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> |
