Skip to content

Commit

Permalink
Manual page updates for tip
Browse files Browse the repository at this point in the history
  • Loading branch information
Staysail Systems, Inc authored and gdamore committed Feb 22, 2024
1 parent 9970a2d commit e96b0be
Show file tree
Hide file tree
Showing 325 changed files with 1,711 additions and 1,688 deletions.
8 changes: 5 additions & 3 deletions man/tip/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1262,7 +1262,7 @@ <h2 id="_section_3tls_supplemental_tls_functions">Section 3tls: Supplemental TLS
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
Contact <a href="https://staysail.tech">Staysail Systems</a> for
Contact <a href="https://staysail.tech">Staysail Systems, Inc.</a> for
details about commercially available options, including support for
FIPS 140-2 validated cryptography and TLS v1.3.
</td>
Expand Down Expand Up @@ -1467,13 +1467,15 @@ <h2 id="_section_7_protocols_and_transports">Section 7: Protocols and Transports
available in the distribution.</p>
</div>
<div class="paragraph">
<p>Protocols implement communication patterns, such as
<p>
Protocols implement communication patterns, such as
request/reply, publish/subscribe, and so forth.
A given <a href="nng_socket.5.html">socket</a> is created with exactly one protocol, and that
protocol defines the key behavior of the socket.</p>
</div>
<div class="paragraph">
<p>Conversely, transports are the underlying mechansims by which messages
<p>
Conversely, transports are the underlying mechansims by which messages
are moved between participants, such as TCP/IP or UNIX domain IPC.
A given <a href="nng_socket.5.html">socket</a> may be using several transports at the same
time.</p>
Expand Down
4 changes: 2 additions & 2 deletions man/tip/nn_allocmsg.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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-o">*</span><span class="tok-nf">nn_allocmsg</span><span class="tok-p">(</span><span class="tok-kt">size_t</span> <span class="tok-n">size</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">type</span><span class="tok-p">);</span></code></pre>
<span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-nf">nn_allocmsg</span><span class="tok-p">(</span><span class="tok-kt">size_t</span><span class="tok-w"> </span><span class="tok-n">size</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">type</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions man/tip/nn_bind.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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">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>
<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">nn_bind</span><span class="tok-p">(</span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">sock</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-k">const</span><span class="tok-w"> </span><span class="tok-kt">char</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">url</span><span class="tok-p">)</span></code></pre>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions man/tip/nn_close.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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">int</span> <span class="tok-nf">nn_close</span><span class="tok-p">(</span><span class="tok-kt">int</span> <span class="tok-n">sock</span><span class="tok-p">);</span></code></pre>
<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nn_close</span><span class="tok-p">(</span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">sock</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
Expand Down
10 changes: 5 additions & 5 deletions man/tip/nn_cmsg.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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-k">struct</span> <span class="tok-n">nn_cmsghdr</span> <span class="tok-p">{</span>
<span class="tok-kt">size_t</span> <span class="tok-n">cmsg_len</span><span class="tok-p">;</span>
<span class="tok-kt">int</span> <span class="tok-n">cmsg_level</span><span class="tok-p">;</span>
<span class="tok-kt">int</span> <span class="tok-n">cmsg_type</span><span class="tok-p">;</span>
<span class="tok-k">struct</span><span class="tok-w"> </span><span class="tok-nc">nn_cmsghdr</span><span class="tok-w"> </span><span class="tok-p">{</span>
<span class="tok-w"> </span><span class="tok-kt">size_t</span><span class="tok-w"> </span><span class="tok-n">cmsg_len</span><span class="tok-p">;</span>
<span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">cmsg_level</span><span class="tok-p">;</span>
<span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">cmsg_type</span><span class="tok-p">;</span>
<span class="tok-p">};</span></code></pre>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions man/tip/nn_connect.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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">int</span> <span class="tok-nf">nn_connect</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>
<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">nn_connect</span><span class="tok-p">(</span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">sock</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-k">const</span><span class="tok-w"> </span><span class="tok-kt">char</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">url</span><span class="tok-p">)</span></code></pre>
</div>
</div>
</div>
Expand Down
6 changes: 3 additions & 3 deletions man/tip/nn_device.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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">int</span> <span class="tok-nf">nn_device</span><span class="tok-p">(</span><span class="tok-kt">int</span> <span class="tok-n">sock1</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">sock2</span><span class="tok-p">);</span></code></pre>
<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nn_device</span><span class="tok-p">(</span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">sock1</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">sock2</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
Expand Down Expand Up @@ -48,7 +48,7 @@ <h2 id="_description">DESCRIPTION</h2>
</div>
<div class="paragraph">
<p>The two sockets must be compatible, and must be
<a href="nng.7.html">raw mode</a>
<a href="nng.7.html#raw_mode">raw mode</a>
sockets.
More detail about devices and how they can be used is available in the
new style <a href="nng_device.3.html">nng_device()</a> documentation.</p>
Expand Down
4 changes: 2 additions & 2 deletions man/tip/nn_errno.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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">int</span> <span class="tok-nf">nn_errno</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre>
<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nn_errno</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions man/tip/nn_freemsg.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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">int</span> <span class="tok-nf">nn_freemsg</span><span class="tok-p">(</span><span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre>
<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nn_freemsg</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions man/tip/nn_get_statistic.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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">uint64_t</span> <span class="tok-nf">nn_get_statistic</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-kt">int</span> <span class="tok-n">stat</span><span class="tok-p">);</span></code></pre>
<span class="tok-kt">uint64_t</span><span class="tok-w"> </span><span class="tok-nf">nn_get_statistic</span><span class="tok-p">(</span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">sock</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">stat</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions man/tip/nn_getsockopt.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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">int</span> <span class="tok-nf">nn_getsockopt</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-kt">int</span> <span class="tok-n">level</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">option</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">val</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">szp</span><span class="tok-p">);</span></code></pre>
<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nn_getsockopt</span><span class="tok-p">(</span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">sock</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">level</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">option</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">val</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">size_t</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">szp</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
Expand Down
12 changes: 6 additions & 6 deletions man/tip/nn_poll.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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-cp">#define NN_POLLIN 1</span>
<span class="tok-cp">#define NN_POLLOUT 2</span>

<span class="tok-k">struct</span> <span class="tok-n">nn_pollfd</span> <span class="tok-p">{</span>
<span class="tok-kt">int</span> <span class="tok-n">fd</span><span class="tok-p">;</span>
<span class="tok-kt">uint16_t</span> <span class="tok-n">events</span><span class="tok-p">;</span>
<span class="tok-kt">uint16_t</span> <span class="tok-n">revents</span><span class="tok-p">;</span>
<span class="tok-k">struct</span><span class="tok-w"> </span><span class="tok-nc">nn_pollfd</span><span class="tok-w"> </span><span class="tok-p">{</span>
<span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">fd</span><span class="tok-p">;</span>
<span class="tok-w"> </span><span class="tok-kt">uint16_t</span><span class="tok-w"> </span><span class="tok-n">events</span><span class="tok-p">;</span>
<span class="tok-w"> </span><span class="tok-kt">uint16_t</span><span class="tok-w"> </span><span class="tok-n">revents</span><span class="tok-p">;</span>
<span class="tok-p">};</span>

<span class="tok-kt">int</span> <span class="tok-nf">nn_poll</span><span class="tok-p">(</span><span class="tok-k">struct</span> <span class="tok-n">nn_pollfd</span> <span class="tok-o">*</span><span class="tok-n">pfds</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">npfd</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">timeout</span><span class="tok-p">);</span></code></pre>
<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nn_poll</span><span class="tok-p">(</span><span class="tok-k">struct</span><span class="tok-w"> </span><span class="tok-nc">nn_pollfd</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">pfds</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">npfd</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">timeout</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions man/tip/nn_reallocmsg.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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-o">*</span><span class="tok-nf">nn_reallocmsg</span><span class="tok-p">(</span><span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">old</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span></code></pre>
<span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-nf">nn_reallocmsg</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">old</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">size_t</span><span class="tok-w"> </span><span class="tok-n">size</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions man/tip/nn_recv.3compat.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ <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">&lt;nanomsg/nn.h&gt;</span>
<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">int</span> <span class="tok-nf">nn_recv</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-kt">void</span> <span class="tok-o">*</span><span class="tok-n">data</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">size</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">flags</span><span class="tok-p">)</span></code></pre>
<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">nn_recv</span><span class="tok-p">(</span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">sock</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">data</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">size_t</span><span class="tok-w"> </span><span class="tok-n">size</span><span class="tok-p">,</span><span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">flags</span><span class="tok-p">)</span></code></pre>
</div>
</div>
</div>
Expand Down
Loading

0 comments on commit e96b0be

Please sign in to comment.