diff options
| author | Staysail Systems, Inc. <info@staysail.tech> | 2023-09-14 00:24:50 -0700 |
|---|---|---|
| committer | Staysail Systems, Inc. <info@staysail.tech> | 2023-09-14 00:24:50 -0700 |
| commit | bff4599ecd97ea28e1e2016fedf6cc1d53beda5c (patch) | |
| tree | 74055c7863fc04e89a1dbf029cc99c498d9557f3 | |
| parent | 110cc2e7249421111710e151047e67cd764ea31a (diff) | |
| download | nng-bff4599ecd97ea28e1e2016fedf6cc1d53beda5c.tar.gz nng-bff4599ecd97ea28e1e2016fedf6cc1d53beda5c.tar.bz2 nng-bff4599ecd97ea28e1e2016fedf6cc1d53beda5c.zip | |
Manual page updates for tip
324 files changed, 2747 insertions, 1521 deletions
diff --git a/man/tip/_toc.html b/man/tip/_toc.html index c2135fc8..c788149d 100644 --- a/man/tip/_toc.html +++ b/man/tip/_toc.html @@ -14,6 +14,7 @@ <li><a href="nng_aio_abort.3.html">nng_aio_abort</a></li> <li><a href="nng_aio_alloc.3.html">nng_aio_alloc</a></li> <li><a href="nng_aio_begin.3.html">nng_aio_begin</a></li> +<li><a href="nng_aio_busy.3.html">nng_aio_busy</a></li> <li><a href="nng_aio_cancel.3.html">nng_aio_cancel</a></li> <li><a href="nng_aio_count.3.html">nng_aio_count</a></li> <li><a href="nng_aio_defer.3.html">nng_aio_defer</a></li> @@ -39,7 +40,9 @@ <li><a href="nng_ctx_id.3.html">nng_ctx_id</a></li> <li><a href="nng_ctx_open.3.html">nng_ctx_open</a></li> <li><a href="nng_ctx_recv.3.html">nng_ctx_recv</a></li> +<li><a href="nng_ctx_recvmsg.3.html">nng_ctx_recvmsg</a></li> <li><a href="nng_ctx_send.3.html">nng_ctx_send</a></li> +<li><a href="nng_ctx_sendmsg.3.html">nng_ctx_sendmsg</a></li> <li><a href="nng_ctx_set.3.html">nng_ctx_set</a></li> <li><a href="nng_ctx_setopt.3.html">nng_ctx_setopt</a></li> <li><a href="nng_device.3.html">nng_device</a></li> @@ -68,6 +71,7 @@ <li><a href="nng_msg_alloc.3.html">nng_msg_alloc</a></li> <li><a href="nng_msg_append.3.html">nng_msg_append</a></li> <li><a href="nng_msg_body.3.html">nng_msg_body</a></li> +<li><a href="nng_msg_capacity.3.html">nng_msg_capacity</a></li> <li><a href="nng_msg_chop.3.html">nng_msg_chop</a></li> <li><a href="nng_msg_clear.3.html">nng_msg_clear</a></li> <li><a href="nng_msg_dup.3.html">nng_msg_dup</a></li> @@ -83,6 +87,7 @@ <li><a href="nng_msg_insert.3.html">nng_msg_insert</a></li> <li><a href="nng_msg_len.3.html">nng_msg_len</a></li> <li><a href="nng_msg_realloc.3.html">nng_msg_realloc</a></li> +<li><a href="nng_msg_reserve.3.html">nng_msg_reserve</a></li> <li><a href="nng_msg_set_pipe.3.html">nng_msg_set_pipe</a></li> <li><a href="nng_msg_trim.3.html">nng_msg_trim</a></li> <li><a href="nng_pair_open.3.html">nng_pair_open</a></li> @@ -111,6 +116,7 @@ <li><a href="nng_socket_get.3.html">nng_socket_get</a></li> <li><a href="nng_socket_id.3.html">nng_socket_id</a></li> <li><a href="nng_socket_set.3.html">nng_socket_set</a></li> +<li><a href="nng_stat_bool.3.html">nng_stat_bool</a></li> <li><a href="nng_stat_child.3.html">nng_stat_child</a></li> <li><a href="nng_stat_desc.3.html">nng_stat_desc</a></li> <li><a href="nng_stat_find.3.html">nng_stat_find</a></li> diff --git a/man/tip/index.html b/man/tip/index.html index 5829d252..5492cbae 100644 --- a/man/tip/index.html +++ b/man/tip/index.html @@ -59,6 +59,10 @@ primary API for building such applications.</p> <td class="tableblock halign-left valign-top"><p class="tableblock">begin asynchronous I/O operation</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_aio_busy.3.html">nng_aio_busy(3)</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">test if asynchronous I/O is busy</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_aio_cancel.3.html">nng_aio_cancel(3)</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">cancel asynchronous I/O operation</p></td> </tr> @@ -159,10 +163,18 @@ primary API for building such applications.</p> <td class="tableblock halign-left valign-top"><p class="tableblock">receive message using context asynchronously</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ctx_recvmsg.3.html">nng_ctx_recvmsg(3)</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">receive message using socket</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ctx_send.3.html">nng_ctx_send(3)</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">send message using context asynchronously</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ctx_sendmsg.3.html">nng_ctx_sendmsg(3)</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">send message using context</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ctx_set.3.html">nng_ctx_set(3)</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">set context option</p></td> </tr> @@ -275,6 +287,10 @@ primary API for building such applications.</p> <td class="tableblock halign-left valign-top"><p class="tableblock">return message body</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_msg_capacity.3.html">nng_msg_capacity(3)</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">return message body length</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_msg_chop.3.html">nng_msg_chop(3)</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">remove data from end of message body</p></td> </tr> @@ -335,6 +351,10 @@ primary API for building such applications.</p> <td class="tableblock halign-left valign-top"><p class="tableblock">reallocate a message</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_msg_reserve.3.html">nng_msg_reserve(3)</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">reserve storage for a message</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_msg_set_pipe.3.html">nng_msg_set_pipe(3)</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">set pipe for message</p></td> </tr> @@ -400,7 +420,7 @@ primary API for building such applications.</p> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_recvmsg.3.html">nng_recvmsg(3)</a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">recv message</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">receive a message</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_rep_open.3.html">nng_rep_open(3)</a></p></td> @@ -447,6 +467,10 @@ primary API for building such applications.</p> <td class="tableblock halign-left valign-top"><p class="tableblock">set socket option</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_stat_bool.3.html">nng_stat_bool(3)</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">get statistic Boolean value</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_stat_child.3.html">nng_stat_child(3)</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">get child statistic</p></td> </tr> @@ -496,7 +520,7 @@ primary API for building such applications.</p> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_stat_value.3.html">nng_stat_value(3)</a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">get statistic value</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">get statistic numeric value</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_stats_free.3.html">nng_stats_free(3)</a></p></td> @@ -1230,7 +1254,7 @@ additional support was present and enabled with <em>libnng</em> was built.</p> <i class="fa icon-tip" title="Tip"></i> </td> <td class="content"> -Contact <a href="https://staysail.tech">Staysail Systems, Inc.</a> for +Contact <a href="https://staysail.tech">Staysail Systems</a> for details about commercially available options, including support for FIPS 140-2 validated cryptography and TLS v1.3. </td> diff --git a/man/tip/libnng.3.html b/man/tip/libnng.3.html index 99c4ec95..c5c31fae 100644 --- a/man/tip/libnng.3.html +++ b/man/tip/libnng.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: libnng(3) --- <h1>libnng(3)</h1> <div class="sect1"> @@ -271,6 +272,10 @@ Most applications will only interact with the body.</p> <td class="tableblock halign-left valign-top"><p class="tableblock">return message body</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_msg_capacity.3.html">nng_msg_capacity()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">return capacity allocated for message body</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_msg_chop.3.html">nng_msg_chop()</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">remove data from end of message body</p></td> </tr> @@ -303,6 +308,10 @@ Most applications will only interact with the body.</p> <td class="tableblock halign-left valign-top"><p class="tableblock">reallocate a message</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_msg_reserve.3.html">nng_msg_reserve()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">reserve storage for message body</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_msg_set_pipe.3.html">nng_msg_set_pipe()</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">set pipe for message</p></td> </tr> @@ -431,6 +440,10 @@ Only a single asynchronous operation may be associated with an <td class="tableblock halign-left valign-top"><p class="tableblock">begin asynchronous I/O operation</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_aio_busy.3.html">nng_aio_busy()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">test if asynchronous I/O is busy</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_aio_cancel.3.html">nng_aio_cancel()</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">cancel asynchronous I/O operation</p></td> </tr> @@ -463,6 +476,10 @@ Only a single asynchronous operation may be associated with an <td class="tableblock halign-left valign-top"><p class="tableblock">return output result</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_aio_free.3.html">nng_aio_reap()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">reap asynchronous I/O handle</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_aio_result.3.html">nng_aio_result()</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">return result of asynchronous operation</p></td> </tr> @@ -644,10 +661,18 @@ concurrent applications.</p> <td class="tableblock halign-left valign-top"><p class="tableblock">receive message using context asynchronously</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ctx_recvmsg.3.html">nng_ctx_recvmsg()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">receive a message using context</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ctx_send.3.html">nng_ctx_send()</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">send message using context asynchronously</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ctx_sendmsg.3.html">nng_ctx_sendmsg()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">send a message using context</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ctx_set.3.html">nng_ctx_set()</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">set context option</p></td> </tr> @@ -671,6 +696,10 @@ to observe program behaviors and as an aid in troubleshooting.</p> </colgroup> <tbody> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_stat_bool.3.html">nng_stat_bool()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">get statistic Boolean value</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_stat_child.3.html">nng_stat_child()</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">get child statistic</p></td> </tr> @@ -720,7 +749,7 @@ to observe program behaviors and as an aid in troubleshooting.</p> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_stat_value.3.html">nng_stat_value()</a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">get statistic value</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">get statistic numeric value</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_stats_free.3.html">nng_stats_free()</a></p></td> diff --git a/man/tip/nn_allocmsg.3compat.html b/man/tip/nn_allocmsg.3compat.html index b0d09673..4f388ac3 100644 --- a/man/tip/nn_allocmsg.3compat.html +++ b/man/tip/nn_allocmsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_allocmsg(3compat) --- <h1>nn_allocmsg(3compat)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></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-n">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> +<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">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> </div> </div> </div> diff --git a/man/tip/nn_bind.3compat.html b/man/tip/nn_bind.3compat.html index 12e82146..65215ba4 100644 --- a/man/tip/nn_bind.3compat.html +++ b/man/tip/nn_bind.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_bind(3compat) --- <h1>nn_bind(3compat)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-n">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> +<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> diff --git a/man/tip/nn_close.3compat.html b/man/tip/nn_close.3compat.html index 6070a7c4..5d0abc92 100644 --- a/man/tip/nn_close.3compat.html +++ b/man/tip/nn_close.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_close(3compat) --- <h1>nn_close(3compat)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> +<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_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> </div> </div> diff --git a/man/tip/nn_cmsg.3compat.html b/man/tip/nn_cmsg.3compat.html index 7527aeba..d2073382 100644 --- a/man/tip/nn_cmsg.3compat.html +++ b/man/tip/nn_cmsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_cmsg(3compat) --- <h1>nn_cmsg(3compat)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> +<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-k">struct</span> <span class="tok-n">nn_cmsghdr</span> <span class="tok-p">{</span> - <span class="tok-n">size_t</span> <span class="tok-n">cmsg_len</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-p">};</span></code></pre> diff --git a/man/tip/nn_connect.3compat.html b/man/tip/nn_connect.3compat.html index f26f22ea..673affaf 100644 --- a/man/tip/nn_connect.3compat.html +++ b/man/tip/nn_connect.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_connect(3compat) --- <h1>nn_connect(3compat)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-n">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> +<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_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> </div> </div> </div> diff --git a/man/tip/nn_device.3compat.html b/man/tip/nn_device.3compat.html index 9e760c05..0f333eb5 100644 --- a/man/tip/nn_device.3compat.html +++ b/man/tip/nn_device.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_device(3compat) --- <h1>nn_device(3compat)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> +<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_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> </div> </div> diff --git a/man/tip/nn_errno.3compat.html b/man/tip/nn_errno.3compat.html index 98d38740..cb13b3e8 100644 --- a/man/tip/nn_errno.3compat.html +++ b/man/tip/nn_errno.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_errno(3compat) --- <h1>nn_errno(3compat)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> +<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_errno</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nn_freemsg.3compat.html b/man/tip/nn_freemsg.3compat.html index 7692fd38..11a3b7a4 100644 --- a/man/tip/nn_freemsg.3compat.html +++ b/man/tip/nn_freemsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_freemsg(3compat) --- <h1>nn_freemsg(3compat)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> +<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_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> </div> </div> diff --git a/man/tip/nn_get_statistic.3compat.html b/man/tip/nn_get_statistic.3compat.html index e9479612..7cca59ba 100644 --- a/man/tip/nn_get_statistic.3compat.html +++ b/man/tip/nn_get_statistic.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_get_statistic(3compat) --- <h1>nn_get_statistic(3compat)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> -<span class="tok-n">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> +<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">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> </div> </div> </div> diff --git a/man/tip/nn_getsockopt.3compat.html b/man/tip/nn_getsockopt.3compat.html index ffa090d8..09e40919 100644 --- a/man/tip/nn_getsockopt.3compat.html +++ b/man/tip/nn_getsockopt.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_getsockopt(3compat) --- <h1>nn_getsockopt(3compat)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">szp</span><span class="tok-p">);</span></code></pre> +<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_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> </div> </div> </div> diff --git a/man/tip/nn_poll.3compat.html b/man/tip/nn_poll.3compat.html index bbe2873c..c420c6e2 100644 --- a/man/tip/nn_poll.3compat.html +++ b/man/tip/nn_poll.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_poll(3compat) --- <h1>nn_poll(3compat)</h1> <div class="sect1"> @@ -16,15 +17,15 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> -<span class="tok-cp">#define NN_POLLIN 1 -</span><span class="tok-cp">#define NN_POLLOUT 2 -</span><span class="tok-cp"></span> +<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-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-n">uint16_t</span> <span class="tok-n">events</span><span class="tok-p">;</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">revents</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-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> diff --git a/man/tip/nn_reallocmsg.3compat.html b/man/tip/nn_reallocmsg.3compat.html index f7dad297..15f8c63c 100644 --- a/man/tip/nn_reallocmsg.3compat.html +++ b/man/tip/nn_reallocmsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_reallocmsg(3compat) --- <h1>nn_reallocmsg(3compat)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></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-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span></code></pre> +<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">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> </div> </div> </div> diff --git a/man/tip/nn_recv.3compat.html b/man/tip/nn_recv.3compat.html index a1b20555..2bf6c3c3 100644 --- a/man/tip/nn_recv.3compat.html +++ b/man/tip/nn_recv.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_recv(3compat) --- <h1>nn_recv(3compat)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-n">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-n">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> +<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_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> </div> </div> </div> diff --git a/man/tip/nn_recvmsg.3compat.html b/man/tip/nn_recvmsg.3compat.html index 307ef831..f0123069 100644 --- a/man/tip/nn_recvmsg.3compat.html +++ b/man/tip/nn_recvmsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_recvmsg(3compat) --- <h1>nn_recvmsg(3compat)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> +<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_recvmsg</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">struct</span> <span class="tok-n">nn_msghdr</span> <span class="tok-o">*</span><span class="tok-n">hdr</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> </div> </div> @@ -57,14 +58,14 @@ following definition:</p> <div class="content"> <pre class="pygments highlight"><code data-lang="c"><span class="tok-k">struct</span> <span class="tok-n">nn_iovec</span> <span class="tok-p">{</span> <span class="tok-kt">void</span> <span class="tok-o">*</span> <span class="tok-n">iov_base</span><span class="tok-p">;</span> - <span class="tok-n">size_t</span> <span class="tok-n">iov_len</span><span class="tok-p">;</span> + <span class="tok-kt">size_t</span> <span class="tok-n">iov_len</span><span class="tok-p">;</span> <span class="tok-p">};</span> <span class="tok-k">struct</span> <span class="tok-n">nn_msghdr</span> <span class="tok-p">{</span> <span class="tok-k">struct</span> <span class="tok-n">nn_iovec</span> <span class="tok-o">*</span><span class="tok-n">msg_iov</span><span class="tok-p">;</span> <span class="tok-kt">int</span> <span class="tok-n">msg_iovlen</span><span class="tok-p">;</span> <span class="tok-kt">void</span> <span class="tok-o">*</span> <span class="tok-n">msg_control</span><span class="tok-p">;</span> - <span class="tok-n">size_t</span> <span class="tok-n">msg_controllen</span><span class="tok-p">;</span> + <span class="tok-kt">size_t</span> <span class="tok-n">msg_controllen</span><span class="tok-p">;</span> <span class="tok-p">};</span></code></pre> </div> </div> diff --git a/man/tip/nn_send.3compat.html b/man/tip/nn_send.3compat.html index a8168423..d5318029 100644 --- a/man/tip/nn_send.3compat.html +++ b/man/tip/nn_send.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_send(3compat) --- <h1>nn_send(3compat)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-n">nn_send</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">void</span> <span class="tok-o">*</span><span class="tok-n">data</span><span class="tok-p">,</span> <span class="tok-n">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> +<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_send</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">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> </div> </div> </div> @@ -51,7 +52,7 @@ In this case, <em>data</em> points not to the message content itself, but instea is a pointer to the pointer, an extra level of pointer indirection. The message must have been previously allocated by <a href="nn_allocmsg.3compat.html"><code>nn_allocmsg()</code></a> or -<a href="nn_recvmsg.3compat.html"><code>nn_recvmsg()</code></a><code>, using the same `NN_MSG</code> size. +<a href="nn_recvmsg.3compat.html"><code>nn_recvmsg()</code></a>`, using the same <code>NN_MSG</code> size. In this case, the ownership of the message shall remain with the caller, unless the function returns 0, indicating that the function has taken responsibility for delivering or disposing of the diff --git a/man/tip/nn_sendmsg.3compat.html b/man/tip/nn_sendmsg.3compat.html index a8491da2..9e4e540a 100644 --- a/man/tip/nn_sendmsg.3compat.html +++ b/man/tip/nn_sendmsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_sendmsg(3compat) --- <h1>nn_sendmsg(3compat)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> +<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_sendmsg</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-k">struct</span> <span class="tok-n">nn_msghdr</span> <span class="tok-o">*</span><span class="tok-n">hdr</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> </div> </div> @@ -57,14 +58,14 @@ following definition:</p> <div class="content"> <pre class="pygments highlight"><code data-lang="c"><span class="tok-k">struct</span> <span class="tok-n">nn_iovec</span> <span class="tok-p">{</span> <span class="tok-kt">void</span> <span class="tok-o">*</span> <span class="tok-n">iov_base</span><span class="tok-p">;</span> - <span class="tok-n">size_t</span> <span class="tok-n">iov_len</span><span class="tok-p">;</span> + <span class="tok-kt">size_t</span> <span class="tok-n">iov_len</span><span class="tok-p">;</span> <span class="tok-p">};</span> <span class="tok-k">struct</span> <span class="tok-n">nn_msghdr</span> <span class="tok-p">{</span> <span class="tok-k">struct</span> <span class="tok-n">nn_iovec</span> <span class="tok-o">*</span><span class="tok-n">msg_iov</span><span class="tok-p">;</span> <span class="tok-kt">int</span> <span class="tok-n">msg_iovlen</span><span class="tok-p">;</span> <span class="tok-kt">void</span> <span class="tok-o">*</span> <span class="tok-n">msg_control</span><span class="tok-p">;</span> - <span class="tok-n">size_t</span> <span class="tok-n">msg_controllen</span><span class="tok-p">;</span> + <span class="tok-kt">size_t</span> <span class="tok-n">msg_controllen</span><span class="tok-p">;</span> <span class="tok-p">};</span></code></pre> </div> </div> diff --git a/man/tip/nn_setsockopt.3compat.html b/man/tip/nn_setsockopt.3compat.html index 4825187a..30856eb5 100644 --- a/man/tip/nn_setsockopt.3compat.html +++ b/man/tip/nn_setsockopt.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_setsockopt(3compat) --- <h1>nn_setsockopt(3compat)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nn_setsockopt</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-k">const</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-n">size_t</span> <span class="tok-n">sz</span><span class="tok-p">);</span></code></pre> +<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_setsockopt</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-k">const</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-n">sz</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nn_shutdown.3compat.html b/man/tip/nn_shutdown.3compat.html index 19c7ed7b..961b2ffe 100644 --- a/man/tip/nn_shutdown.3compat.html +++ b/man/tip/nn_shutdown.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_shutdown(3compat) --- <h1>nn_shutdown(3compat)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-n">nn_shutdown</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">ep</span><span class="tok-p">)</span></code></pre> +<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_shutdown</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">ep</span><span class="tok-p">)</span></code></pre> </div> </div> </div> diff --git a/man/tip/nn_socket.3compat.html b/man/tip/nn_socket.3compat.html index f00c962f..a3fcff69 100644 --- a/man/tip/nn_socket.3compat.html +++ b/man/tip/nn_socket.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_socket(3compat) --- <h1>nn_socket(3compat)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> +<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_socket</span><span class="tok-p">(</span><span class="tok-kt">int</span> <span class="tok-n">af</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">proto</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nn_strerror.3compat.html b/man/tip/nn_strerror.3compat.html index 0bc21fb8..9839ede2 100644 --- a/man/tip/nn_strerror.3compat.html +++ b/man/tip/nn_strerror.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_strerror(3compat) --- <h1>nn_strerror(3compat)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> +<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-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-nf">nn_strerror</span><span class="tok-p">(</span><span class="tok-kt">int</span> <span class="tok-n">err</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nn_term.3compat.html b/man/tip/nn_term.3compat.html index 8309a440..f1249b81 100644 --- a/man/tip/nn_term.3compat.html +++ b/man/tip/nn_term.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_term(3compat) --- <h1>nn_term(3compat)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> +<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">void</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> diff --git a/man/tip/nng.7.html b/man/tip/nng.7.html index b5d31283..310a85e2 100644 --- a/man/tip/nng.7.html +++ b/man/tip/nng.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng(7) --- <h1>nng(7)</h1> <div class="sect1"> @@ -15,7 +16,7 @@ layout: manpage_v2 <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="paragraph"> -<p><strong>cc</strong> ['flags'] 'files' <strong>-lnng</strong> ['libraries']</p> +<p><strong>cc</strong> ['flags'] 'files' <strong>-lnng</strong> ['libraries']</p> </div> </div> </div> @@ -299,6 +300,7 @@ following the format specified in <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>, including some schemes that are unique to SP. + The URLs used in <em>NNG</em> are canonicalized as follows, mostly in accordance with <a href="https://tools.ietf.org/html/rfc3986#section-6.2.2">RFC 3986 6.2.2</a>:</p> @@ -307,32 +309,32 @@ accordance with <ol class="arabic"> <li> <p>The URL is parsed into scheme, userinfo, host, port, path, query and - fragment components. (Not all of these members are necessarily present.)</p> +fragment components. (Not all of these members are necessarily present.)</p> </li> <li> <p>The scheme, hostname, and port if present, are converted to lower case.</p> </li> <li> <p>Percent-encoded values for - <a href="https://tools.ietf.org/html/rfc3986#section-2.3">unreserved characters</a> - converted to their unencoded forms.</p> +<a href="https://tools.ietf.org/html/rfc3986#section-2.3">unreserved characters</a> +converted to their unencoded forms.</p> </li> <li> <p>Additionally URL percent-encoded values for characters in the path - and with numeric values larger than 127 (i.e. not ASCII) are decoded.</p> +and with numeric values larger than 127 (i.e. not ASCII) are decoded.</p> </li> <li> <p>The resulting path is checked for invalid UTF-8 sequences, consisting - of surrogate pairs, illegal byte sequences, or overlong encodings. - If this check fails, then the entire URL is considered invalid.</p> +of surrogate pairs, illegal byte sequences, or overlong encodings. +If this check fails, then the entire URL is considered invalid.</p> </li> <li> <p>Path segments consisting of <code>.</code> and <code>..</code> are resolved as per - <a href="https://tools.ietf.org/html/rfc3986#section-6.2.2.3">RFC 3986 6.2.2.3</a>.</p> +<a href="https://tools.ietf.org/html/rfc3986#section-6.2.2.3">RFC 3986 6.2.2.3</a>.</p> </li> <li> <p>Further, empty path segments are removed, meaning that duplicate - slash (<code>/</code>) separators are removed from the path.</p> +slash (<code>/</code>) separators are removed from the path.</p> </li> </ol> </div> diff --git a/man/tip/nng_aio.5.html b/man/tip/nng_aio.5.html index 97d52a25..8b6be6e8 100644 --- a/man/tip/nng_aio.5.html +++ b/man/tip/nng_aio.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio(5) --- <h1>nng_aio(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_aio</span> <span class="tok-n">nng_aio</span><span class="tok-p">;</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_abort.3.html b/man/tip/nng_aio_abort.3.html index 9cc3defd..3a2e1bb7 100644 --- a/man/tip/nng_aio_abort.3.html +++ b/man/tip/nng_aio_abort.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_abort(3) --- <h1>nng_aio_abort(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_aio_abort</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">err</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_alloc.3.html b/man/tip/nng_aio_alloc.3.html index b6bb44d4..7de57ec3 100644 --- a/man/tip/nng_aio_alloc.3.html +++ b/man/tip/nng_aio_alloc.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_alloc(3) --- <h1>nng_aio_alloc(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_aio_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">**</span><span class="tok-n">aiop</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-p">(</span><span class="tok-o">*</span><span class="tok-n">callb</span><span class="tok-p">)(</span><span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-p">),</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">arg</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -42,7 +43,23 @@ It will be called with the argument <em>arg</em>.</p> <td class="content"> The callback <em>callb</em> must not perform any blocking operations, and must complete its execution quickly. If <em>callb</em> does block, this can -lead ultimately to an apparent "hang" or deadlock in the application. +lead ultimately to an apparent "hang" or deadlock in the application. +This also means you should avoid operations such as allocating new objects, +which also means opening or closing sockets, dialers, and so forth. +</td> +</tr> +</table> +</div> +<div class="admonitionblock tip"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-tip" title="Tip"></i> +</td> +<td class="content"> +If more complex or blocking work needs to be performed by <em>callb</em>, a separate +thread can be used, along with a <a href="nng_cv_alloc.3supp.html">condition variable</a> +which can be signaled by the callback. </td> </tr> </table> diff --git a/man/tip/nng_aio_begin.3.html b/man/tip/nng_aio_begin.3.html index e016d13a..b929bc1a 100644 --- a/man/tip/nng_aio_begin.3.html +++ b/man/tip/nng_aio_begin.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_begin(3) --- <h1>nng_aio_begin(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">bool</span> <span class="tok-nf">nng_aio_begin</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_busy.3.html b/man/tip/nng_aio_busy.3.html new file mode 100644 index 00000000..e8f59f9a --- /dev/null +++ b/man/tip/nng_aio_busy.3.html @@ -0,0 +1,87 @@ +--- +version: tip +layout: manpage_v2 +title: nng_aio_busy(3) +--- +<h1>nng_aio_busy(3)</h1> +<div class="sect1"> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>nng_aio_busy - test if asynchronous I/O is busy</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"><nng/nng.h></span> + +<span class="tok-kt">bool</span> <span class="tok-nf">nng_aio_busy</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</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>nng_aio_busy()</code> function returns true if the +<em>aio</em> is currently busy performing an asynchronous I/O +operation or is executing a completion callback.</p> +</div> +<div class="paragraph"> +<p>If no operation has been started, or the operation has +been completed or canceled, and any callback has been +executed, then it returns false.</p> +</div> +<div class="paragraph"> +<p>This is the same test used internally by +<a href="nng_aio_wait.3.html"><code>nng_aio_wait()</code></a></p> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +Care should be taken to ensure that the <em>aio</em> object is not +freed when using this function. The caller is responsible for +coordinating any use of this with any reuse of the <em>aio</em>. +</td> +</tr> +</table> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_return_values">RETURN VALUES</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>True if the <em>aio</em> is busy, false otherwise.</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="nng_aio_abort.3.html">nng_aio_abort(3)</a>, +<a href="nng_aio_alloc.3.html">nng_aio_alloc(3)</a>, +<a href="nng_aio_wait.3.html">nng_aio_wait(3)</a>, +<a href="nng_aio.5.html">nng_aio(5)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> diff --git a/man/tip/nng_aio_cancel.3.html b/man/tip/nng_aio_cancel.3.html index 6b45e968..1acb3223 100644 --- a/man/tip/nng_aio_cancel.3.html +++ b/man/tip/nng_aio_cancel.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_cancel(3) --- <h1>nng_aio_cancel(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_aio_cancel</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_count.3.html b/man/tip/nng_aio_count.3.html index 9d0bd202..e4fa137f 100644 --- a/man/tip/nng_aio_count.3.html +++ b/man/tip/nng_aio_count.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_count(3) --- <h1>nng_aio_count(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-n">size_t</span> <span class="tok-nf">nng_aio_count</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">size_t</span> <span class="tok-nf">nng_aio_count</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -33,7 +34,7 @@ asynchronous operation associated with the handle <em>aio</em>.</p> <div class="paragraph"> <p>Some asynchronous operations do not provide meaningful data for this function; for example operations that establish connections do not -transfer user data (they may transfer protocol data though) -- in this case +transfer user data (they may transfer protocol data though) — in this case this function will generally return zero.</p> </div> <div class="paragraph"> diff --git a/man/tip/nng_aio_defer.3.html b/man/tip/nng_aio_defer.3.html index 7d97f2fb..9926d83e 100644 --- a/man/tip/nng_aio_defer.3.html +++ b/man/tip/nng_aio_defer.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_defer(3) --- <h1>nng_aio_defer(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-nf">void</span> <span class="tok-p">(</span><span class="tok-o">*</span><span class="tok-n">nng_aio_cancelfn</span><span class="tok-p">)(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">arg</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">err</span><span class="tok-p">);</span> <span class="tok-kt">void</span> <span class="tok-nf">nng_aio_defer</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-n">nng_aio_cancelfn</span> <span class="tok-n">fn</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">arg</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_aio_finish.3.html b/man/tip/nng_aio_finish.3.html index ed6cc091..06ebe9ac 100644 --- a/man/tip/nng_aio_finish.3.html +++ b/man/tip/nng_aio_finish.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_finish(3) --- <h1>nng_aio_finish(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_aio_finish</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">err</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_free.3.html b/man/tip/nng_aio_free.3.html index a0efceb5..f7731383 100644 --- a/man/tip/nng_aio_free.3.html +++ b/man/tip/nng_aio_free.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_free(3) --- <h1>nng_aio_free(3)</h1> <div class="sect1"> @@ -16,9 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">void</span> <span class="tok-nf">nng_aio_free</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">void</span> <span class="tok-nf">nng_aio_free</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span> +<span class="tok-kt">void</span> <span class="tok-nf">nng_aio_reap</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -33,6 +35,23 @@ caller is blocked until the operation is completely canceled, to ensure that it is safe to deallocate the handle and any associated resources. (This is done by implicitly calling <a href="nng_aio_stop.3.html"><code>nng_aio_stop()</code></a>.)</p> </div> +<div class="paragraph"> +<p>The <code>nng_aio_reap()</code> function is the same as <code>nng_aio_free()</code>, but does +it’s work in a background thread. +This can be useful to discard the <em>aio</em> object from within the callback for the <em>aio</em>.</p> +</div> +<div class="admonitionblock important"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-important" title="Important"></i> +</td> +<td class="content"> +Once either of these functions are called, the <em>aio</em> object is invalid and must not be used again. +</td> +</tr> +</table> +</div> </div> </div> <div class="sect1"> diff --git a/man/tip/nng_aio_get_input.3.html b/man/tip/nng_aio_get_input.3.html index e75c3554..170b269b 100644 --- a/man/tip/nng_aio_get_input.3.html +++ b/man/tip/nng_aio_get_input.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_get_input(3) --- <h1>nng_aio_get_input(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-nf">nng_aio_get_input</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-kt">unsigned</span> <span class="tok-kt">int</span> <span class="tok-n">index</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_get_msg.3.html b/man/tip/nng_aio_get_msg.3.html index 21ad688e..bbfa67a3 100644 --- a/man/tip/nng_aio_get_msg.3.html +++ b/man/tip/nng_aio_get_msg.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_get_msg(3) --- <h1>nng_aio_get_msg(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-nf">nng_aio_get_msg</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_get_output.3.html b/man/tip/nng_aio_get_output.3.html index b473e967..9c0aa219 100644 --- a/man/tip/nng_aio_get_output.3.html +++ b/man/tip/nng_aio_get_output.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_get_output(3) --- <h1>nng_aio_get_output(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-nf">nng_aio_get_output</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-kt">unsigned</span> <span class="tok-kt">int</span> <span class="tok-n">index</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_result.3.html b/man/tip/nng_aio_result.3.html index fb93f13f..03a024d9 100644 --- a/man/tip/nng_aio_result.3.html +++ b/man/tip/nng_aio_result.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_result(3) --- <h1>nng_aio_result(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_aio_result</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_set_input.3.html b/man/tip/nng_aio_set_input.3.html index 027b6bc2..12c82f08 100644 --- a/man/tip/nng_aio_set_input.3.html +++ b/man/tip/nng_aio_set_input.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_set_input(3) --- <h1>nng_aio_set_input(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_aio_set_input</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-kt">unsigned</span> <span class="tok-kt">int</span> <span class="tok-n">index</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">param</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_set_iov.3.html b/man/tip/nng_aio_set_iov.3.html index ba739b89..1185844d 100644 --- a/man/tip/nng_aio_set_iov.3.html +++ b/man/tip/nng_aio_set_iov.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_set_iov(3) --- <h1>nng_aio_set_iov(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_aio_set_iov</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-kt">unsigned</span> <span class="tok-kt">int</span> <span class="tok-n">niov</span><span class="tok-p">,</span> <span class="tok-n">nng_iov</span> <span class="tok-o">*</span><span class="tok-n">iov</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -37,7 +38,7 @@ structures, which have the following definition:</p> <div class="content"> <pre class="pygments highlight"><code data-lang="c"> <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_iov</span> <span class="tok-p">{</span> <span class="tok-kt">void</span> <span class="tok-o">*</span> <span class="tok-n">iov_buf</span><span class="tok-p">;</span> - <span class="tok-n">size_t</span> <span class="tok-n">iov_len</span><span class="tok-p">;</span> + <span class="tok-kt">size_t</span> <span class="tok-n">iov_len</span><span class="tok-p">;</span> <span class="tok-p">};</span></code></pre> </div> </div> @@ -46,7 +47,7 @@ structures, which have the following definition:</p> The values pointed to by the <code>iov_buf</code> members are <strong>not</strong> copied by this function though.</p> </div> <div class="paragraph"> -<p>A maximum of eight (8) <code>nng_iov</code> members may be supplied.</p> +<p>A maximum of four (4) <code>nng_iov</code> members may be supplied.</p> </div> <div class="admonitionblock note"> <table> diff --git a/man/tip/nng_aio_set_msg.3.html b/man/tip/nng_aio_set_msg.3.html index 3b4a02e2..08e5a1ff 100644 --- a/man/tip/nng_aio_set_msg.3.html +++ b/man/tip/nng_aio_set_msg.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_set_msg(3) --- <h1>nng_aio_set_msg(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_aio_set_msg</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_set_output.3.html b/man/tip/nng_aio_set_output.3.html index 5b532394..57785005 100644 --- a/man/tip/nng_aio_set_output.3.html +++ b/man/tip/nng_aio_set_output.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_set_output(3) --- <h1>nng_aio_set_output(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_aio_set_output</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-kt">unsigned</span> <span class="tok-kt">int</span> <span class="tok-n">index</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">result</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_set_timeout.3.html b/man/tip/nng_aio_set_timeout.3.html index b237177b..00cd8cbb 100644 --- a/man/tip/nng_aio_set_timeout.3.html +++ b/man/tip/nng_aio_set_timeout.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_set_timeout(3) --- <h1>nng_aio_set_timeout(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-kt">int</span> <span class="tok-n">nng_duration</span><span class="tok-p">;</span> <span class="tok-kt">void</span> <span class="tok-nf">nng_aio_set_timeout</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-n">nng_duration</span> <span class="tok-n">timeout</span><span class="tok-p">);</span></code></pre> </div> @@ -37,7 +38,7 @@ The <em>timeout</em> is specified as a relative number of milliseconds.</p> </div> <div class="paragraph"> <p>If the timeout is <code>NNG_DURATION_INFINITE</code>, then no timeout is used. -If the timeout is <code>NNG_DURATION_DEFAULT</code>, then a "default" or socket-specific +If the timeout is <code>NNG_DURATION_DEFAULT</code>, then a "default" or socket-specific timeout is used. (This is frequently the same as <code>NNG_DURATION_INFINITE</code>.)</p> </div> @@ -49,7 +50,7 @@ timeout is used. </td> <td class="content"> As most operations involve some context switching, it is usually a good -idea to allow at least a few tens of milliseconds before timing them out -- +idea to allow at least a few tens of milliseconds before timing them out —  a too small timeout might not allow the operation to properly begin before giving up! </td> diff --git a/man/tip/nng_aio_stop.3.html b/man/tip/nng_aio_stop.3.html index de8df3c4..10af9899 100644 --- a/man/tip/nng_aio_stop.3.html +++ b/man/tip/nng_aio_stop.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_stop(3) --- <h1>nng_aio_stop(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_aio_stop</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_aio_wait.3.html b/man/tip/nng_aio_wait.3.html index 3759d4d6..ed547232 100644 --- a/man/tip/nng_aio_wait.3.html +++ b/man/tip/nng_aio_wait.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_wait(3) --- <h1>nng_aio_wait(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_aio_wait</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -33,7 +34,7 @@ If the operation has not been started, or has already completed, then it returns immediately.</p> </div> <div class="paragraph"> -<p>If the a callback was set with <em>aio</em> when it was allocated, then this +<p>If a callback was set with <em>aio</em> when it was allocated, then this function will not be called until the callback has completed.</p> </div> </div> @@ -60,6 +61,7 @@ function will not be called until the callback has completed.</p> <div class="paragraph text-left"> <p><a href="nng_aio_abort.3.html">nng_aio_abort(3)</a>, <a href="nng_aio_alloc.3.html">nng_aio_alloc(3)</a>, +<a href="nng_aio_busy.3.html">nng_aio_busy(3)</a>, <a href="nng_aio.5.html">nng_aio(5)</a>, <a href="nng.7.html">nng(7)</a></p> </div> diff --git a/man/tip/nng_alloc.3.html b/man/tip/nng_alloc.3.html index 67decfe3..d8657651 100644 --- a/man/tip/nng_alloc.3.html +++ b/man/tip/nng_alloc.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_alloc(3) --- <h1>nng_alloc(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-nf">nng_alloc</span><span class="tok-p">(</span><span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-nf">nng_alloc</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> </div> </div> </div> diff --git a/man/tip/nng_bus.7.html b/man/tip/nng_bus.7.html index 78797a6f..2d1caaf5 100644 --- a/man/tip/nng_bus.7.html +++ b/man/tip/nng_bus.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_bus(7) --- <h1>nng_bus(7)</h1> <div class="sect1"> diff --git a/man/tip/nng_bus_open.3.html b/man/tip/nng_bus_open.3.html index f66ba632..8d91cdf5 100644 --- a/man/tip/nng_bus_open.3.html +++ b/man/tip/nng_bus_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_bus_open(3) --- <h1>nng_bus_open(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/bus0/bus.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/bus0/bus.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_bus0_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_bus0_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_clock.3supp.html b/man/tip/nng_clock.3supp.html index b7351f56..cac058e3 100644 --- a/man/tip/nng_clock.3supp.html +++ b/man/tip/nng_clock.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_clock(3supp) --- <h1>nng_clock(3supp)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-k">typedef</span> <span class="tok-n">uint64_t</span> <span class="tok-n">nng_time</span><span class="tok-p">;</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + +<span class="tok-k">typedef</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">nng_time</span><span class="tok-p">;</span> <span class="tok-n">nng_time</span> <span class="tok-nf">nng_clock</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_close.3.html b/man/tip/nng_close.3.html index 81901d70..a0bf7ecf 100644 --- a/man/tip/nng_close.3.html +++ b/man/tip/nng_close.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_close(3) --- <h1>nng_close(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_close</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_compat.3compat.html b/man/tip/nng_compat.3compat.html index 7e7c7112..6e4b8764 100644 --- a/man/tip/nng_compat.3compat.html +++ b/man/tip/nng_compat.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_compat(3compat) --- <h1>nng_compat(3compat)</h1> <div class="sect1"> @@ -16,19 +17,19 @@ layout: manpage_v2 <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-cp"> -</span><span class="tok-cp"></span> -<span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/bus.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/pair.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/pipeline.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/pubsub.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/reqrep.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/survey.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/inproc.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/ipc.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/tcp.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/ws.h></span></code></pre> +<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-cp">#include</span> <span class="tok-cpf"><nanomsg/bus.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/pair.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/pipeline.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/pubsub.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/reqrep.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/survey.h></span> + +<span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/inproc.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/ipc.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/tcp.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/ws.h></span></code></pre> </div> </div> </div> @@ -98,7 +99,7 @@ While reasonable efforts have been made to provide for compatibility, some things may behave differently, and some less common parts of the <em>libnanomsg</em> 1.0 API are not supported at this time, including certain options and the statistics API. -See the <a href="#Caveats">[Caveats]</a> section below. +See the <a href="#_caveats">Caveats</a> section below. </td> </tr> </table> @@ -121,8 +122,8 @@ For example, instead of:</p> </div> <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-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/reqrep.h></span></code></pre> +<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-cp">#include</span> <span class="tok-cpf"><nanomsg/reqrep.h></span></code></pre> </div> </div> <div class="paragraph"> @@ -130,8 +131,8 @@ For example, instead of:</p> </div> <div class="listingblock"> <div class="content"> -<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/compat/nanomsg/nn.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/compat/nanomsg/reqrep.h></span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/compat/nanomsg/nn.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/compat/nanomsg/reqrep.h></span></code></pre> </div> </div> <div class="paragraph"> @@ -144,14 +145,11 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> <div class="paragraph"> <p>The following functions are provided:</p> </div> -<div class="paragraph"> -<p>ifndef::backend-pdf[]</p> -</div> <div class="hdlist"> <table> <tr> <td class="hdlist1"> -<a href="nn_socket.3compat.html"><code>nn_socket()</code></a> +<a href="nn_socket.3compat.html">`nn_socket()`</a> </td> <td class="hdlist2"> <p>create socket</p> @@ -159,7 +157,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_getsockopt.3compat.html"><code>nn_getsockopt()</code></a> +<a href="nn_getsockopt.3compat.html">`nn_getsockopt()`</a> </td> <td class="hdlist2"> <p>get socket option</p> @@ -167,7 +165,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_setsockopt.3compat.html"><code>nn_setsockopt()</code></a> +<a href="nn_setsockopt.3compat.html">`nn_setsockopt()`</a> </td> <td class="hdlist2"> <p>set socket option</p> @@ -175,7 +173,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_bind.3compat.html"><code>nn_bind()</code></a> +<a href="nn_bind.3compat.html">`nn_bind()`</a> </td> <td class="hdlist2"> <p>accept connections from remote peers</p> @@ -183,7 +181,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_connect.3compat.html"><code>nn_connect()</code></a> +<a href="nn_connect.3compat.html">`nn_connect()`</a> </td> <td class="hdlist2"> <p>connect to remote peer</p> @@ -191,7 +189,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_send.3compat.html"><code>nn_send()</code></a> +<a href="nn_send.3compat.html">`nn_send()`</a> </td> <td class="hdlist2"> <p>send data</p> @@ -199,7 +197,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_recv.3compat.html"><code>nn_recv()</code></a> +<a href="nn_recv.3compat.html">`nn_recv()`</a> </td> <td class="hdlist2"> <p>receive data</p> @@ -207,7 +205,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_shutdown.3compat.html"><code>nn_shutdown()</code></a> +<a href="nn_shutdown.3compat.html">`nn_shutdown()`</a> </td> <td class="hdlist2"> <p>shut down endpoint</p> @@ -215,7 +213,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_close.3compat.html"><code>nn_close()</code></a> +<a href="nn_close.3compat.html">`nn_close()`</a> </td> <td class="hdlist2"> <p>close socket</p> @@ -223,7 +221,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_poll.3compat.html"><code>nn_poll()</code></a> +<a href="nn_poll.3compat.html">`nn_poll()`</a> </td> <td class="hdlist2"> <p>poll sockets</p> @@ -231,7 +229,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_device.3compat.html"><code>nn_device()</code></a> +<a href="nn_device.3compat.html">`nn_device()`</a> </td> <td class="hdlist2"> <p>create forwarding device</p> @@ -239,7 +237,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_recvmsg.3compat.html"><code>nn_recvmsg()</code></a> +<a href="nn_recvmsg.3compat.html">`nn_recvmsg()`</a> </td> <td class="hdlist2"> <p>receive message</p> @@ -247,7 +245,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_sendmsg.3compat.html"><code>nn_sendmsg()</code></a> +<a href="nn_sendmsg.3compat.html">`nn_sendmsg()`</a> </td> <td class="hdlist2"> <p>send message</p> @@ -255,7 +253,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_cmsg.3compat.html"><code>nn_cmsg()</code></a> +<a href="nn_cmsg.3compat.html">`nn_cmsg()`</a> </td> <td class="hdlist2"> <p>message control data</p> @@ -263,7 +261,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_get_statistic.3compat.html"><code>nn_get_statistic()</code></a> +<a href="nn_get_statistic.3compat.html">`nn_get_statistic()`</a> </td> <td class="hdlist2"> <p>get statistic (stub)</p> @@ -271,7 +269,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_allocmsg.3compat.html"><code>nn_allocmsg()</code></a> +<a href="nn_allocmsg.3compat.html">`nn_allocmsg()`</a> </td> <td class="hdlist2"> <p>allocate message</p> @@ -279,7 +277,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_reallocmsg.3compat.html"><code>nn_reallocmsg()</code></a> +<a href="nn_reallocmsg.3compat.html">`nn_reallocmsg()`</a> </td> <td class="hdlist2"> <p>reallocate message</p> @@ -287,7 +285,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_freemsg.3compat.html"><code>nn_freemsg()</code></a> +<a href="nn_freemsg.3compat.html">`nn_freemsg()`</a> </td> <td class="hdlist2"> <p>free message</p> @@ -295,7 +293,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_errno.3compat.html"><code>nn_errno()</code></a> +<a href="nn_errno.3compat.html">`nn_errno()`</a> </td> <td class="hdlist2"> <p>return most recent error</p> @@ -303,7 +301,7 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_strerror.3compat.html"><code>nn_strerror()</code></a> +<a href="nn_strerror.3compat.html">`nn_strerror()`</a> </td> <td class="hdlist2"> <p>return message for error</p> @@ -311,111 +309,14 @@ instead of <em>libnn</em>, just like any other <em>NNG</em> application.</p> </tr> <tr> <td class="hdlist1"> -<a href="nn_term.3compat.html"><code>nn_term()</code></a> +<a href="nn_term.3compat.html">`nn_term()`</a> </td> <td class="hdlist2"> -<p>terminate library -endif::[] -ifdef::backend-pdf[]</p> +<p>terminate library</p> </td> </tr> </table> </div> -<table class="tableblock frame-all grid-rows hdlist" style="width: 90%;"> -<colgroup> -<col style="width: 33.3333%;"> -<col style="width: 66.6667%;"> -</colgroup> -<tbody> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_socket.3compat.html"><code>nn_socket()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">create socket</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_getsockopt.3compat.html"><code>nn_getsockopt()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">get socket option</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_setsockopt.3compat.html"><code>nn_setsockopt()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">set socket option</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_bind.3compat.html"><code>nn_bind()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">accept connections from remote peers</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_connect.3compat.html"><code>nn_connect()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">connect to remote peer</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_send.3compat.html"><code>nn_send()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">send data</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_recv.3compat.html"><code>nn_recv()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">receive data</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_shutdown.3compat.html"><code>nn_shutdown()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">shut down endpoint</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_close.3compat.html"><code>nn_close()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">close socket</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_poll.3compat.html"><code>nn_poll()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">poll sockets</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_device.3compat.html"><code>nn_device()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">create forwarding device</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_recvmsg.3compat.html"><code>nn_recvmsg()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">receive message</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_sendmsg.3compat.html"><code>nn_sendmsg()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">send message</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_cmsg.3compat.html"><code>nn_cmsg()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">message control data</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_get_statistic.3compat.html"><code>nn_get_statistic()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">get statistic (stub)</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_allocmsg.3compat.html"><code>nn_allocmsg()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">allocate message</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_reallocmsg.3compat.html"><code>nn_reallocmsg()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">reallocate message</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_freemsg.3compat.html"><code>nn_freemsg()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">free message</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_errno.3compat.html"><code>nn_errno()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">return most recent error</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_strerror.3compat.html"><code>nn_strerror()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">return message for error</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nn_term.3compat.html"><code>nn_term()</code></a></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">terminate library</p></td> -</tr> -</tbody> -</table> -<div class="paragraph"> -<p>endif::[]</p> -</div> </div> <div class="sect2"> <h3 id="_caveats">Caveats</h3> @@ -426,69 +327,69 @@ ifdef::backend-pdf[]</p> <ul> <li> <p>Socket numbers can be quite large. - The legacy <em>libnanomsg</em> attempted to reuse socket numbers, like - file descriptors in UNIX systems. - <em>NNG</em> avoids this to prevent accidental reuse or - collision after a descriptor is closed. - Consequently, socket numbers can become quite large, and should - probably not be used for array indices.</p> +The legacy <em>libnanomsg</em> attempted to reuse socket numbers, like +file descriptors in UNIX systems. +<em>NNG</em> avoids this to prevent accidental reuse or +collision after a descriptor is closed. +Consequently, socket numbers can become quite large, and should +probably not be used for array indices.</p> </li> <li> <p>The following options (<code>nn_getsockopt</code>) are unsupported: - <code>NN_SNDPRIO</code>, <code>NN_RCVPRIO</code>, <code>NN_IPV4ONLY</code>. - The priority options may be supported in the future, when - the underlying capability is present in <em>NNG</em>.</p> +<code>NN_SNDPRIO</code>, <code>NN_RCVPRIO</code>, <code>NN_IPV4ONLY</code>. +The priority options may be supported in the future, when +the underlying capability is present in <em>NNG</em>.</p> </li> <li> <p>Access to statistics using this legacy API - (<a href="nn_get_statistic.3compat.html"><code>nn_get_statistic()</code></a>) is unsupported.</p> +(<a href="nn_get_statistic.3compat.html"><code>nn_get_statistic()</code></a>) is unsupported.</p> </li> <li> <p>Some transports can support longer URLs than legacy <em>libnanomsg</em> can. - It is a good idea to use short pathnames in URLs if interoperability - is a concern.</p> +It is a good idea to use short pathnames in URLs if interoperability +is a concern.</p> </li> <li> <p>Only absolute paths are supported in <code>ipc://</code> URLs. - For example, <code>ipc:///tmp/mysocket</code> is acceptable, but <code>ipc://mysocket</code> is not.</p> +For example, <code>ipc:///tmp/mysocket</code> is acceptable, but <code>ipc://mysocket</code> is not.</p> </li> <li> <p>The WebSocket transport in this implementation (<code>ws://</code> URLs) - only supports BINARY frames.</p> +only supports BINARY frames.</p> </li> <li> <p>Some newer transports are unusable from this mode. - In particular, this legacy API offers no way to configure - TLS or ZeroTier parameters that may be required for use.</p> +In particular, this legacy API offers no way to configure +TLS or ZeroTier parameters that may be required for use.</p> </li> <li> <p>ABI versioning of the compatibility layer is not supported, - and the <code>NN_VERSION_</code> macros are not present.</p> +and the <code>NN_VERSION_</code> macros are not present.</p> </li> <li> <p>Runtime symbol information is not implemented. - Specifically, there is no <code>nn_symbol()</code> function yet. - (This may be addressed later if there is a need.)</p> +Specifically, there is no <code>nn_symbol()</code> function yet. +(This may be addressed later if there is a need.)</p> </li> <li> <p>The TCP transport (<code>tcp://</code> URLs) does not support specifying the local - address or interface when binding. (This could be fixed in the future, - but most likely this will be available only using the new API.)</p> +address or interface when binding. (This could be fixed in the future, +but most likely this will be available only using the new API.)</p> </li> <li> <p>The values of <code>NN_RCVMAXSIZE</code> are constrained. - Specifically, values set larger than 2GB using the new API will be reported - as unlimited (<code>-1</code>) in the new API, and the value <code>0</code> will disable any - enforcement, just like <code>-1</code>. - (There is no practical reason to ever want to limit the receive size to - zero.)</p> +Specifically, values set larger than 2GB using the new API will be reported +as unlimited (<code>-1</code>) in the new API, and the value <code>0</code> will disable any +enforcement, just like <code>-1</code>. +(There is no practical reason to ever want to limit the receive size to +zero.)</p> </li> <li> <p>This implementation counts buffers in terms of messages rather than bytes. - As a result, the buffer sizes accessed with <code>NN_SNDBUF</code> and <code>NN_RCVBUF</code> are - rounded up to a whole number of kilobytes, then divided by 1024, in order - to approximate buffering assuming 1 KB messages. - Few applications should need to adjust the default values.</p> +As a result, the buffer sizes accessed with <code>NN_SNDBUF</code> and <code>NN_RCVBUF</code> are +rounded up to a whole number of kilobytes, then divided by 1024, in order +to approximate buffering assuming 1 KB messages. +Few applications should need to adjust the default values.</p> </li> </ul> </div> diff --git a/man/tip/nng_ctx.5.html b/man/tip/nng_ctx.5.html index e601c848..a006c34b 100644 --- a/man/tip/nng_ctx.5.html +++ b/man/tip/nng_ctx.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx(5) --- <h1>nng_ctx(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_ctx_s</span> <span class="tok-n">nng_ctx</span></code></pre> </div> </div> @@ -156,8 +157,7 @@ to the sender.</p> </div> <div class="listingblock"> <div class="content"> -<pre class="pygments highlight"><code data-lang="c"> -<span class="tok-k">struct</span> <span class="tok-n">echo_context</span> <span class="tok-p">{</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-k">struct</span> <span class="tok-n">echo_context</span> <span class="tok-p">{</span> <span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</span><span class="tok-p">;</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">;</span> <span class="tok-k">enum</span> <span class="tok-p">{</span> <span class="tok-n">INIT</span><span class="tok-p">,</span> <span class="tok-n">RECV</span><span class="tok-p">,</span> <span class="tok-n">SEND</span> <span class="tok-p">}</span> <span class="tok-n">state</span><span class="tok-p">;</span> @@ -171,22 +171,25 @@ to the sender.</p> <span class="tok-k">switch</span> <span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">state</span><span class="tok-p">)</span> <span class="tok-p">{</span> <span class="tok-k">case</span> <span class="tok-nl">INIT</span><span class="tok-p">:</span> <span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">state</span> <span class="tok-o">=</span> <span class="tok-n">RECV</span><span class="tok-p">;</span> - <span class="tok-n">nng_ctx_recv</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">ctx</span><span class="tok-p">,</span> <span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">aio</span><span class="tok-p">);</span> + <span class="tok-nf">nng_ctx_recv</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">ctx</span><span class="tok-p">,</span> <span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">aio</span><span class="tok-p">);</span> <span class="tok-k">return</span><span class="tok-p">;</span> <span class="tok-k">case</span> <span class="tok-nl">RECV</span><span class="tok-p">:</span> - <span class="tok-k">if</span> <span class="tok-p">(</span><span class="tok-n">nng_aio_result</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">aio</span><span class="tok-p">)</span> <span class="tok-o">!=</span> <span class="tok-mi">0</span><span class="tok-p">)</span> <span class="tok-p">{</span> + <span class="tok-k">if</span> <span class="tok-p">(</span><span class="tok-nf">nng_aio_result</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">aio</span><span class="tok-p">)</span> <span class="tok-o">!=</span> <span class="tok-mi">0</span><span class="tok-p">)</span> <span class="tok-p">{</span> <span class="tok-c1">// ... handle error -</span><span class="tok-c1"></span> <span class="tok-p">}</span> +</span> + <span class="tok-p">}</span> <span class="tok-c1">// We reuse the message on the ec->aio -</span><span class="tok-c1"></span> <span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">state</span> <span class="tok-o">=</span> <span class="tok-n">SEND</span><span class="tok-p">;</span> - <span class="tok-n">nng_ctx_send</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">ctx</span><span class="tok-p">,</span> <span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">aio</span><span class="tok-p">);</span> +</span> + <span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">state</span> <span class="tok-o">=</span> <span class="tok-n">SEND</span><span class="tok-p">;</span> + <span class="tok-nf">nng_ctx_send</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">ctx</span><span class="tok-p">,</span> <span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">aio</span><span class="tok-p">);</span> <span class="tok-k">return</span><span class="tok-p">;</span> <span class="tok-k">case</span> <span class="tok-nl">SEND</span><span class="tok-p">:</span> - <span class="tok-k">if</span> <span class="tok-p">(</span><span class="tok-n">nng_aio_result</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">aio</span><span class="tok-p">)</span> <span class="tok-o">!=</span> <span class="tok-mi">0</span><span class="tok-p">)</span> <span class="tok-p">{</span> + <span class="tok-k">if</span> <span class="tok-p">(</span><span class="tok-nf">nng_aio_result</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">aio</span><span class="tok-p">)</span> <span class="tok-o">!=</span> <span class="tok-mi">0</span><span class="tok-p">)</span> <span class="tok-p">{</span> <span class="tok-c1">// ... handle error -</span><span class="tok-c1"></span> <span class="tok-p">}</span> +</span> + <span class="tok-p">}</span> <span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">state</span> <span class="tok-o">=</span> <span class="tok-n">RECV</span><span class="tok-p">;</span> - <span class="tok-n">nng_ctx_recv</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">ctx</span><span class="tok-p">,</span> <span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">aio</span><span class="tok-p">);</span> + <span class="tok-nf">nng_ctx_recv</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">ctx</span><span class="tok-p">,</span> <span class="tok-n">ec</span><span class="tok-o">-></span><span class="tok-n">aio</span><span class="tok-p">);</span> <span class="tok-k">return</span><span class="tok-p">;</span> <span class="tok-p">}</span> <span class="tok-p">}</span></code></pre> @@ -201,8 +204,8 @@ or <a href="nng_listen.3.html"><code>nng_listen()</code></a>.</p> </div> <div class="listingblock"> <div class="content"> -<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#define CONCURRENCY 1024 -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#define CONCURRENCY 1024</span> + <span class="tok-n">echo_context</span> <span class="tok-n">ecs</span><span class="tok-p">[</span><span class="tok-n">CONCURRENCY</span><span class="tok-p">];</span> <span class="tok-kt">void</span> @@ -210,11 +213,13 @@ or <a href="nng_listen.3.html"><code>nng_listen()</code></a>.</p> <span class="tok-p">{</span> <span class="tok-k">for</span> <span class="tok-p">(</span><span class="tok-kt">int</span> <span class="tok-n">i</span> <span class="tok-o">=</span> <span class="tok-mi">0</span><span class="tok-p">;</span> <span class="tok-n">i</span> <span class="tok-o"><</span> <span class="tok-n">CONCURRENCY</span><span class="tok-p">;</span> <span class="tok-n">i</span><span class="tok-o">++</span><span class="tok-p">)</span> <span class="tok-p">{</span> <span class="tok-c1">// error checks elided for clarity -</span><span class="tok-c1"></span> <span class="tok-n">nng_ctx_open</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-p">[</span><span class="tok-n">i</span><span class="tok-p">].</span><span class="tok-n">ctx</span><span class="tok-p">,</span> <span class="tok-n">rep_socket</span><span class="tok-p">)</span> - <span class="tok-n">nng_aio_alloc</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-p">[</span><span class="tok-n">i</span><span class="tok-p">].</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-n">echo</span><span class="tok-p">,</span> <span class="tok-o">&</span><span class="tok-n">e</span><span class="tok-p">[</span><span class="tok-n">i</span><span class="tok-p">]);</span> +</span> + <span class="tok-nf">nng_ctx_open</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-p">[</span><span class="tok-n">i</span><span class="tok-p">].</span><span class="tok-n">ctx</span><span class="tok-p">,</span> <span class="tok-n">rep_socket</span><span class="tok-p">)</span> + <span class="tok-nf">nng_aio_alloc</span><span class="tok-p">(</span><span class="tok-n">ec</span><span class="tok-p">[</span><span class="tok-n">i</span><span class="tok-p">].</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-n">echo</span><span class="tok-p">,</span> <span class="tok-o">&</span><span class="tok-n">e</span><span class="tok-p">[</span><span class="tok-n">i</span><span class="tok-p">]);</span> <span class="tok-n">ec</span><span class="tok-p">[</span><span class="tok-n">i</span><span class="tok-p">].</span><span class="tok-n">state</span> <span class="tok-o">=</span> <span class="tok-n">INIT</span><span class="tok-p">;</span> - <span class="tok-n">echo</span><span class="tok-p">(</span><span class="tok-o">&</span><span class="tok-n">ec</span><span class="tok-p">[</span><span class="tok-n">i</span><span class="tok-p">]);</span> <span class="tok-c1">// start it running -</span><span class="tok-c1"></span> <span class="tok-p">}</span> + <span class="tok-nf">echo</span><span class="tok-p">(</span><span class="tok-o">&</span><span class="tok-n">ec</span><span class="tok-p">[</span><span class="tok-n">i</span><span class="tok-p">]);</span> <span class="tok-c1">// start it running +</span> + <span class="tok-p">}</span> <span class="tok-p">}</span></code></pre> </div> </div> @@ -227,11 +232,13 @@ or <a href="nng_listen.3.html"><code>nng_listen()</code></a>.</p> <p><a href="libnng.3.html">libnng(3)</a>, <a href="nng_ctx_close.3.html">nng_ctx_close(3)</a>, <a href="nng_ctx_open.3.html">nng_ctx_open(3)</a>, -<a href="nng_ctx_getopt.3.html">nng_ctx_getopt(3)</a>, +<a href="nng_ctx_get.3.html">nng_ctx_get(3)</a>, <a href="nng_ctx_id.3.html">nng_ctx_id(3)</a>, <a href="nng_ctx_recv.3.html">nng_ctx_recv(3)</a>, +<a href="nng_ctx_recvmsg.3.html">nng_ctx_recvmsg(3)</a>, <a href="nng_ctx_send.3.html">nng_ctx_send(3)</a>, -<a href="nng_ctx_setopt.3.html">nng_ctx_setopt(3)</a>, +<a href="nng_ctx_sendmsg.3.html">nng_ctx_sendmsg(3)</a>, +<a href="nng_ctx_set.3.html">nng_ctx_set(3)</a>, <a href="nng_dialer.5.html">nng_dialer(5)</a>, <a href="nng_listener.5.html">nng_listener(5)</a>, <a href="nng_socket.5.html">nng_socket(5)</a>, diff --git a/man/tip/nng_ctx_close.3.html b/man/tip/nng_ctx_close.3.html index f024ed61..90637944 100644 --- a/man/tip/nng_ctx_close.3.html +++ b/man/tip/nng_ctx_close.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_close(3) --- <h1>nng_ctx_close(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_close</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_ctx_get.3.html b/man/tip/nng_ctx_get.3.html index e0575644..3ff491a9 100644 --- a/man/tip/nng_ctx_get.3.html +++ b/man/tip/nng_ctx_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_get(3) --- <h1>nng_ctx_get(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_get</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_get</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</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">valszp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_get_bool</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span> @@ -26,11 +27,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_get_ms</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_duration</span> <span class="tok-o">*</span><span class="tok-n">durp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_get_string</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_ctx_getopt.3.html b/man/tip/nng_ctx_getopt.3.html index 8cfe15e6..f721aa45 100644 --- a/man/tip/nng_ctx_getopt.3.html +++ b/man/tip/nng_ctx_getopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_getopt(3) --- <h1>nng_ctx_getopt(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_getopt</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_getopt</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</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">valszp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_getopt_bool</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span> @@ -26,11 +27,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_getopt_ms</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_duration</span> <span class="tok-o">*</span><span class="tok-n">durp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_getopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_getopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_getopt_string</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_getopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_getopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -38,14 +39,15 @@ layout: manpage_v2 <div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> -<div class="admonitionblock note"> +<div class="admonitionblock important"> <table> <tr> <td class="icon"> -<i class="fa icon-note" title="Note"></i> +<i class="fa icon-important" title="Important"></i> </td> <td class="content"> These functions are deprecated. Please see <a href="nng_ctx_get.3.html">nng_ctx_get</a>. +They may not be present if the library was built with <code>NNG_ELIDE_DEPRECATED</code>. </td> </tr> </table> diff --git a/man/tip/nng_ctx_id.3.html b/man/tip/nng_ctx_id.3.html index f6948f57..ecf1f58c 100644 --- a/man/tip/nng_ctx_id.3.html +++ b/man/tip/nng_ctx_id.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_id(3) --- <h1>nng_ctx_id(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_id</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">c</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_ctx_open.3.html b/man/tip/nng_ctx_open.3.html index 8a81e32d..5b3e8cc4 100644 --- a/man/tip/nng_ctx_open.3.html +++ b/man/tip/nng_ctx_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_open(3) --- <h1>nng_ctx_open(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_open</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-o">*</span><span class="tok-n">ctxp</span><span class="tok-p">,</span> <span class="tok-n">nng_socket</span> <span class="tok-n">s</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_ctx_recv.3.html b/man/tip/nng_ctx_recv.3.html index 3e01d810..79ff4855 100644 --- a/man/tip/nng_ctx_recv.3.html +++ b/man/tip/nng_ctx_recv.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_recv(3) --- <h1>nng_ctx_recv(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_ctx_recv</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_ctx_recvmsg.3.html b/man/tip/nng_ctx_recvmsg.3.html new file mode 100644 index 00000000..1a86f10f --- /dev/null +++ b/man/tip/nng_ctx_recvmsg.3.html @@ -0,0 +1,148 @@ +--- +version: tip +layout: manpage_v2 +title: nng_ctx_recvmsg(3) +--- +<h1>nng_ctx_recvmsg(3)</h1> +<div class="sect1"> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>nng_ctx_recvmsg - receive message using socket</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"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_recvmsg</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</span><span class="tok-p">,</span> <span class="tok-n">nng_msg</span> <span class="tok-o">**</span><span class="tok-n">msgp</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> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The <code>nng_ctx_recvmsg()</code> receives a message on context <em>ctx</em>, storing the +received message at the location pointed to by <em>msgp</em>.</p> +</div> +<div class="paragraph"> +<p>The <em>flags</em> may contain the following value:</p> +</div> +<div class="dlist"> +<dl> +<dt class="hdlist1"><code>NNG_FLAG_NONBLOCK</code></dt> +<dd> +<p>The function returns immediately, even if no message is available. +Without this flag, the function will wait until a message is receivable +on the context <em>ctx</em>, or any configured timer expires.</p> +</dd> +</dl> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +The semantics of what receiving a message means vary from protocol to +protocol, so examination of the protocol documentation is encouraged. +</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 0 on success, and non-zero otherwise.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_errors">ERRORS</h2> +<div class="sectionbody"> +<div class="hdlist"> +<table> +<tr> +<td class="hdlist1"> +<code>NNG_EAGAIN</code> +</td> +<td class="hdlist2"> +<p>The operation would block, but <code>NNG_FLAG_NONBLOCK</code> was specified.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ECLOSED</code> +</td> +<td class="hdlist2"> +<p>The context or socket is not open.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_EINVAL</code> +</td> +<td class="hdlist2"> +<p>An invalid set of <em>flags</em> was specified.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ENOMEM</code> +</td> +<td class="hdlist2"> +<p>Insufficient memory is available.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ENOTSUP</code> +</td> +<td class="hdlist2"> +<p>The protocol does not support receiving.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ESTATE</code> +</td> +<td class="hdlist2"> +<p>The context cannot receive data in this state.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ETIMEDOUT</code> +</td> +<td class="hdlist2"> +<p>The operation timed out.</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="nng_msg_free.3.html">nng_msg_free(3)</a>, +<a href="nng_ctx_open.3.html">nng_ctx_open(3)</a>, +<a href="nng_ctx_recv.3.html">nng_ctx_recv(3)</a>, +<a href="nng_ctx_sendmsg.3.html">nng_ctx_sendmsg(3)</a>, +<a href="nng_strerror.3.html">nng_strerror(3)</a>, +<a href="nng_ctx.5.html">nng_ctx(5)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> diff --git a/man/tip/nng_ctx_send.3.html b/man/tip/nng_ctx_send.3.html index 5b64e811..647eec6c 100644 --- a/man/tip/nng_ctx_send.3.html +++ b/man/tip/nng_ctx_send.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_send(3) --- <h1>nng_ctx_send(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_ctx_send</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_ctx_sendmsg.3.html b/man/tip/nng_ctx_sendmsg.3.html new file mode 100644 index 00000000..fad9ad25 --- /dev/null +++ b/man/tip/nng_ctx_sendmsg.3.html @@ -0,0 +1,187 @@ +--- +version: tip +layout: manpage_v2 +title: nng_ctx_sendmsg(3) +--- +<h1>nng_ctx_sendmsg(3)</h1> +<div class="sect1"> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>nng_ctx_sendmsg - send message using context</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"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_sendmsg</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">c</span><span class="tok-p">,</span> <span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</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> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The <code>nng_ctx_sendmsg()</code> sends message <em>msg</em> using the context <em>ctx</em>.</p> +</div> +<div class="paragraph"> +<p>If the function returns zero, indicating it has accepted the message for +delivery, then the <em>msg</em> is owned by the socket <em>s</em>, and the caller +must not make any further use of it. +The socket will free the message when it is finished.</p> +</div> +<div class="paragraph"> +<p>If the function returns non-zero, then it is the caller’s responsibility +to dispose of the <em>msg</em>, which may include freeing it, sending it to +another socket, or simply trying again later.</p> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +The semantics of what sending a message means vary from protocol to +protocol, so examination of the protocol documentation is encouraged. +</td> +</tr> +</table> +</div> +<div class="paragraph"> +<p>The <em>flags</em> may contain the following value:</p> +</div> +<div class="dlist"> +<dl> +<dt class="hdlist1"><code>NNG_FLAG_NONBLOCK</code></dt> +<dd> +<p>The function returns immediately, regardless of whether +the context is able to accept the data or not. +If the context is unable to accept the data (such as if backpressure exists +because the peers are consuming messages too slowly, or no peer is present), +then the function will return with <code>NNG_EAGAIN</code>. +If this flag is not specified, then the function will block if such a +condition exists.</p> +</dd> +</dl> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +Regardless of the presence or absence of <code>NNG_FLAG_NONBLOCK</code>, there may +be queues between the sender and the receiver. +Furthermore, there is no guarantee that the message has actually been delivered. +Finally, with some protocols, the semantic is implicitly <code>NNG_FLAG_NONBLOCK</code>. +</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 0 on success, and non-zero otherwise.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_errors">ERRORS</h2> +<div class="sectionbody"> +<div class="hdlist"> +<table> +<tr> +<td class="hdlist1"> +<code>NNG_EAGAIN</code> +</td> +<td class="hdlist2"> +<p>The operation would block, but <code>NNG_FLAG_NONBLOCK</code> was specified.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ECLOSED</code> +</td> +<td class="hdlist2"> +<p>The context or socket is not open.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_EINVAL</code> +</td> +<td class="hdlist2"> +<p>An invalid set of <em>flags</em> was specified.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_EMSGSIZE</code> +</td> +<td class="hdlist2"> +<p>The value of <em>size</em> is too large.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ENOMEM</code> +</td> +<td class="hdlist2"> +<p>Insufficient memory is available.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ENOTSUP</code> +</td> +<td class="hdlist2"> +<p>The protocol does not support sending.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ESTATE</code> +</td> +<td class="hdlist2"> +<p>The context cannot send data in this state.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ETIMEDOUT</code> +</td> +<td class="hdlist2"> +<p>The operation timed out.</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="nng_msg_alloc.3.html">nng_msg_alloc(3)</a>, +<a href="nng_ctx_open.3.html">nng_ctx_open(3)</a>, +<a href="nng_ctx_recvmsg.3.html">nng_ctx_recvmsg(3)</a>, +<a href="nng_ctx_send.3.html">nng_ctx_send(3)</a>, +<a href="nng_sendmsg.3.html">nng_sendmsg(3)</a>, +<a href="nng_strerror.3.html">nng_strerror(3)</a>, +<a href="nng_msg.5.html">nng_msg(5)</a>, +<a href="nng_ctx.5.html">nng_ctx(5)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> diff --git a/man/tip/nng_ctx_set.3.html b/man/tip/nng_ctx_set.3.html index 3f1adae7..98db4b3b 100644 --- a/man/tip/nng_ctx_set.3.html +++ b/man/tip/nng_ctx_set.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_set(3) --- <h1>nng_ctx_set(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_set</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">valsz</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_set</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">valsz</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_set_bool</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">bval</span><span class="tok-p">);</span> @@ -26,11 +27,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_set_ms</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_duration</span> <span class="tok-n">dur</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_set_string</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</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">str</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_ctx_setopt.3.html b/man/tip/nng_ctx_setopt.3.html index 04d1163f..bbe7e3b2 100644 --- a/man/tip/nng_ctx_setopt.3.html +++ b/man/tip/nng_ctx_setopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_setopt(3) --- <h1>nng_ctx_setopt(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_setopt</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">valsz</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_setopt</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">valsz</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_setopt_bool</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">bval</span><span class="tok-p">);</span> @@ -26,11 +27,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_setopt_ms</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_duration</span> <span class="tok-n">dur</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_setopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_setopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_setopt_string</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</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">str</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_setopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_ctx_setopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_ctx</span> <span class="tok-n">ctx</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -38,14 +39,15 @@ layout: manpage_v2 <div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> -<div class="admonitionblock note"> +<div class="admonitionblock important"> <table> <tr> <td class="icon"> -<i class="fa icon-note" title="Note"></i> +<i class="fa icon-important" title="Important"></i> </td> <td class="content"> These functions are deprecated. Please see <a href="nng_ctx_set.3.html">nng_ctx_set</a>. +They may not be present if the library was built with <code>NNG_ELIDE_DEPRECATED</code>. </td> </tr> </table> diff --git a/man/tip/nng_cv_alloc.3supp.html b/man/tip/nng_cv_alloc.3supp.html index 69f608a5..c30305d4 100644 --- a/man/tip/nng_cv_alloc.3supp.html +++ b/man/tip/nng_cv_alloc.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_alloc(3supp) --- <h1>nng_cv_alloc(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_cv</span> <span class="tok-n">nng_cv</span><span class="tok-p">;</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_cv_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_cv</span> <span class="tok-o">**</span><span class="tok-n">cvp</span><span class="tok-p">,</span> <span class="tok-n">nng_mtx</span> <span class="tok-o">*</span><span class="tok-n">mtx</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_cv_free.3supp.html b/man/tip/nng_cv_free.3supp.html index aca2ce03..16df21de 100644 --- a/man/tip/nng_cv_free.3supp.html +++ b/man/tip/nng_cv_free.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_free(3supp) --- <h1>nng_cv_free(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_cv_free</span><span class="tok-p">(</span><span class="tok-n">nng_cv</span> <span class="tok-o">*</span><span class="tok-n">cv</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_cv_until.3supp.html b/man/tip/nng_cv_until.3supp.html index 1c3848ea..547fa523 100644 --- a/man/tip/nng_cv_until.3supp.html +++ b/man/tip/nng_cv_until.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_until(3supp) --- <h1>nng_cv_until(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_cv_until</span><span class="tok-p">(</span><span class="tok-n">nng_cv</span> <span class="tok-o">*</span><span class="tok-n">cv</span><span class="tok-p">,</span> <span class="tok-n">nng_time</span> <span class="tok-n">when</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -66,25 +67,28 @@ tests for true. <div class="listingblock"> <div class="title">Example 1: Waiting for the condition</div> <div class="content"> -<pre class="pygments highlight"><code data-lang="c"> - <span class="tok-n">nng_mtx_lock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span> <span class="tok-c1">// assume cv was allocated using m -</span><span class="tok-c1"></span> <span class="tok-k">while</span> <span class="tok-p">(</span><span class="tok-o">!</span><span class="tok-n">condition_true</span><span class="tok-p">)</span> <span class="tok-p">{</span> - <span class="tok-k">if</span> <span class="tok-p">(</span><span class="tok-n">nng_cv_wait</span><span class="tok-p">(</span><span class="tok-n">cv</span><span class="tok-p">)</span> <span class="tok-o">==</span> <span class="tok-n">NNG_ETIMEDOUT</span><span class="tok-p">)</span> <span class="tok-p">{</span> - <span class="tok-n">printf</span><span class="tok-p">(</span><span class="tok-s">"Time out reached!</span><span class="tok-se">\n</span><span class="tok-s">"</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"> <span class="tok-n">expire</span> <span class="tok-o">=</span> <span class="tok-nf">nng_clock</span><span class="tok-p">()</span> <span class="tok-o">+</span> <span class="tok-mi">1000</span><span class="tok-p">;</span> <span class="tok-c1">// 1 second in the future +</span> + <span class="tok-nf">nng_mtx_lock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span> <span class="tok-c1">// assume cv was allocated using m +</span> + <span class="tok-k">while</span> <span class="tok-p">(</span><span class="tok-o">!</span><span class="tok-n">condition_true</span><span class="tok-p">)</span> <span class="tok-p">{</span> + <span class="tok-k">if</span> <span class="tok-p">(</span><span class="tok-nf">nng_cv_until</span><span class="tok-p">(</span><span class="tok-n">cv</span><span class="tok-p">,</span> <span class="tok-n">expire</span><span class="tok-p">)</span> <span class="tok-o">==</span> <span class="tok-n">NNG_ETIMEDOUT</span><span class="tok-p">)</span> <span class="tok-p">{</span> + <span class="tok-nf">printf</span><span class="tok-p">(</span><span class="tok-s">"Time out reached!</span><span class="tok-se">\n</span><span class="tok-s">"</span><span class="tok-p">);</span> <span class="tok-k">break</span><span class="tok-p">;</span> <span class="tok-p">}</span> <span class="tok-p">}</span> <span class="tok-c1">// condition_true is true -</span><span class="tok-c1"></span> <span class="tok-n">nng_mtx_unlock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span></code></pre> +</span> + <span class="tok-nf">nng_mtx_unlock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span></code></pre> </div> </div> <div class="listingblock"> <div class="title">Example 2: Signaling the condition</div> <div class="content"> -<pre class="pygments highlight"><code data-lang="c"> <span class="tok-n">nng_mtx_lock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"> <span class="tok-nf">nng_mtx_lock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span> <span class="tok-n">condition_true</span> <span class="tok-o">=</span> <span class="tok-nb">true</span><span class="tok-p">;</span> - <span class="tok-n">nng_cv_wake</span><span class="tok-p">(</span><span class="tok-n">cv</span><span class="tok-p">);</span> - <span class="tok-n">nng_mtx_unlock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span></code></pre> + <span class="tok-nf">nng_cv_wake</span><span class="tok-p">(</span><span class="tok-n">cv</span><span class="tok-p">);</span> + <span class="tok-nf">nng_mtx_unlock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_cv_wait.3supp.html b/man/tip/nng_cv_wait.3supp.html index 3692861d..3370395c 100644 --- a/man/tip/nng_cv_wait.3supp.html +++ b/man/tip/nng_cv_wait.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_wait(3supp) --- <h1>nng_cv_wait(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_cv_wait</span><span class="tok-p">(</span><span class="tok-n">nng_cv</span> <span class="tok-o">*</span><span class="tok-n">cv</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -65,22 +66,23 @@ tests for true. <div class="listingblock"> <div class="title">Example 1: Waiting for the condition</div> <div class="content"> -<pre class="pygments highlight"><code data-lang="c"> - <span class="tok-n">nng_mtx_lock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span> <span class="tok-c1">// assume cv was allocated using m -</span><span class="tok-c1"></span> <span class="tok-k">while</span> <span class="tok-p">(</span><span class="tok-o">!</span><span class="tok-n">condition_true</span><span class="tok-p">)</span> <span class="tok-p">{</span> - <span class="tok-n">nng_cv_wait</span><span class="tok-p">(</span><span class="tok-n">cv</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"> <span class="tok-nf">nng_mtx_lock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span> <span class="tok-c1">// assume cv was allocated using m +</span> + <span class="tok-k">while</span> <span class="tok-p">(</span><span class="tok-o">!</span><span class="tok-n">condition_true</span><span class="tok-p">)</span> <span class="tok-p">{</span> + <span class="tok-nf">nng_cv_wait</span><span class="tok-p">(</span><span class="tok-n">cv</span><span class="tok-p">);</span> <span class="tok-p">}</span> <span class="tok-c1">// condition_true is true -</span><span class="tok-c1"></span> <span class="tok-n">nng_mtx_unlock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span></code></pre> +</span> + <span class="tok-nf">nng_mtx_unlock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span></code></pre> </div> </div> <div class="listingblock"> <div class="title">Example 2: Signaling the condition</div> <div class="content"> -<pre class="pygments highlight"><code data-lang="c"> <span class="tok-n">nng_mtx_lock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"> <span class="tok-nf">nng_mtx_lock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span> <span class="tok-n">condition_true</span> <span class="tok-o">=</span> <span class="tok-nb">true</span><span class="tok-p">;</span> - <span class="tok-n">nng_cv_wake</span><span class="tok-p">(</span><span class="tok-n">cv</span><span class="tok-p">);</span> - <span class="tok-n">nng_mtx_unlock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span></code></pre> + <span class="tok-nf">nng_cv_wake</span><span class="tok-p">(</span><span class="tok-n">cv</span><span class="tok-p">);</span> + <span class="tok-nf">nng_mtx_unlock</span><span class="tok-p">(</span><span class="tok-n">m</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_cv_wake.3supp.html b/man/tip/nng_cv_wake.3supp.html index 97d04f8a..bd84f71b 100644 --- a/man/tip/nng_cv_wake.3supp.html +++ b/man/tip/nng_cv_wake.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_wake(3supp) --- <h1>nng_cv_wake(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_cv_wake</span><span class="tok-p">(</span><span class="tok-n">nng_cv</span> <span class="tok-o">*</span><span class="tok-n">cv</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_cv_wake1.3supp.html b/man/tip/nng_cv_wake1.3supp.html index 5178d8da..b94dff5a 100644 --- a/man/tip/nng_cv_wake1.3supp.html +++ b/man/tip/nng_cv_wake1.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_wake1(3supp) --- <h1>nng_cv_wake1(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_cv_wake1</span><span class="tok-p">(</span><span class="tok-n">nng_cv</span> <span class="tok-o">*</span><span class="tok-n">cv</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_device.3.html b/man/tip/nng_device.3.html index d74722be..5b10e2ad 100644 --- a/man/tip/nng_device.3.html +++ b/man/tip/nng_device.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_device(3) --- <h1>nng_device(3)</h1> <div class="sect1"> @@ -16,9 +17,11 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_device</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s1</span><span class="tok-p">,</span> <span class="tok-n">nng_socket</span> <span class="tok-n">s2</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_device</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s1</span><span class="tok-p">,</span> <span class="tok-n">nng_socket</span> <span class="tok-n">s2</span><span class="tok-p">);</span> + +<span class="tok-kt">void</span> <span class="tok-nf">nng_device_aio</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-n">nng_socket</span> <span class="tok-n">s1</span><span class="tok-p">,</span> <span class="tok-n">nng_socket</span> <span class="tok-n">s2</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -27,11 +30,11 @@ layout: manpage_v2 <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> <div class="paragraph"> -<p>The <code>nng_device()</code> function forwards messages received from one +<p>The <code>nng_device()</code> and <code>nng_device_aio()</code> functions forward messages received from one <a href="nng_socket.5.html">socket</a> <em>s1</em> to another socket <em>s2</em>, and vice versa.</p> </div> <div class="paragraph"> -<p>This function is used to create forwarders, which can be used to create +<p>These functions are used to create forwarders, which can be used to create complex network topologies to provide for improved horizontal scalability, reliability, and isolation.</p> </div> @@ -43,7 +46,9 @@ such as <a href="nng_req_open.3.html"><code>nng_req0_open_raw()</code></a>.</p> </div> <div class="paragraph"> <p>The <code>nng_device()</code> function does not return until one of the sockets -is closed.</p> +is closed. +The <code>nng_device_aio()</code> function returns immediately, and operates completely in +the background.</p> </div> <div class="sect2"> <h3 id="_reflectors">Reflectors</h3> @@ -56,7 +61,7 @@ a protocol that is bidirectional and can peer with itself (such as <a href="nng_bus.7.html"><em>bus</em></a>.) In this case the device acts as a reflector or loop-back device, where messages received from the valid socket are merely returned -back to the sender.</p> +to the sender.</p> </div> </div> <div class="sect2"> @@ -88,6 +93,10 @@ This allows replies to be returned to requesters, and responses to be routed back to surveyors.</p> </div> <div class="paragraph"> +<p>The caller of these functions is required to close the sockets when the +device is stopped.</p> +</div> +<div class="paragraph"> <p>Additionally, some protocols have a maximum time-to-live to protect against forwarding loops and especially amplification loops. In these cases, the default limit (usually 8), ensures that messages will @@ -118,7 +127,7 @@ to network performance. <i class="fa icon-note" title="Note"></i> </td> <td class="content"> -Devices (forwarders and reflectors) act in best effort delivery mode only. +Devices (forwarders and reflectors) act in best-effort delivery mode only. If a message is received from one socket that cannot be accepted by the other (due to backpressure or other issues), then the message is discarded. </td> diff --git a/man/tip/nng_dial.3.html b/man/tip/nng_dial.3.html index 9ec1eb1c..7e0a7efe 100644 --- a/man/tip/nng_dial.3.html +++ b/man/tip/nng_dial.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dial(3) --- <h1>nng_dial(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_dial</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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> <span class="tok-n">nng_dialer</span> <span class="tok-o">*</span><span class="tok-n">dp</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> </div> </div> diff --git a/man/tip/nng_dialer.5.html b/man/tip/nng_dialer.5.html index 3947fd2a..ee62d7a2 100644 --- a/man/tip/nng_dialer.5.html +++ b/man/tip/nng_dialer.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer(5) --- <h1>nng_dialer(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_dialer_s</span> <span class="tok-n">nng_dialer</span><span class="tok-p">;</span></code></pre> </div> </div> diff --git a/man/tip/nng_dialer_close.3.html b/man/tip/nng_dialer_close.3.html index d14adc99..858dac60 100644 --- a/man/tip/nng_dialer_close.3.html +++ b/man/tip/nng_dialer_close.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_close(3) --- <h1>nng_dialer_close(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_close</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_dialer_create.3.html b/man/tip/nng_dialer_create.3.html index 5a7e3daa..d3a43ec5 100644 --- a/man/tip/nng_dialer_create.3.html +++ b/man/tip/nng_dialer_create.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_create(3) --- <h1>nng_dialer_create(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_create</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-o">*</span><span class="tok-n">dialerp</span><span class="tok-p">,</span> <span class="tok-n">nng_socket</span> <span class="tok-n">s</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> diff --git a/man/tip/nng_dialer_get.3.html b/man/tip/nng_dialer_get.3.html index a8ab0ab1..e89c43a7 100644 --- a/man/tip/nng_dialer_get.3.html +++ b/man/tip/nng_dialer_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_get(3) --- <h1>nng_dialer_get(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</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">valszp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_bool</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span> @@ -28,13 +29,13 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">ptr</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_addr</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">sap</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_string</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -49,8 +50,7 @@ The actual options that may be retrieved in this way vary, and many are documented in <a href="nng_options.5.html">nng_options(5)</a>.</p> </div> <div class="paragraph"> -<p>Additionally some transport-specific options and protocol-specific options -are documented with the transports and protocols themselves.</p> +<p>Additionally some transport-specific options are documented with the transports themselves.</p> </div> <div class="sect2"> <h3 id="_forms">Forms</h3> diff --git a/man/tip/nng_dialer_getopt.3.html b/man/tip/nng_dialer_getopt.3.html index 7b4e573c..18ec4fb9 100644 --- a/man/tip/nng_dialer_getopt.3.html +++ b/man/tip/nng_dialer_getopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_getopt(3) --- <h1>nng_dialer_getopt(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_getopt</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_getopt</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</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">valszp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_getopt_bool</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span> @@ -28,13 +29,13 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_getopt_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">ptr</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_getopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_getopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_getopt_sockaddr</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">sap</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_getopt_string</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_getopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_getopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -42,14 +43,15 @@ layout: manpage_v2 <div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> -<div class="admonitionblock note"> +<div class="admonitionblock important"> <table> <tr> <td class="icon"> -<i class="fa icon-note" title="Note"></i> +<i class="fa icon-important" title="Important"></i> </td> <td class="content"> These functions are deprecated. Please see <a href="nng_dialer_get.3.html">nng_dialer_get</a>. +They may not be present if the library was built with <code>NNG_ELIDE_DEPRECATED</code>. </td> </tr> </table> @@ -61,8 +63,7 @@ The actual options that may be retrieved in this way vary, and many are documented in <a href="nng_options.5.html">nng_options(5)</a>.</p> </div> <div class="paragraph"> -<p>Additionally some transport-specific options and protocol-specific options -are documented with the transports and protocols themselves.</p> +<p>Additionally some transport-specific options are documented with the transports themselves.</p> </div> <div class="sect2"> <h3 id="_forms">Forms</h3> diff --git a/man/tip/nng_dialer_id.3.html b/man/tip/nng_dialer_id.3.html index ce0ec568..1b44db8b 100644 --- a/man/tip/nng_dialer_id.3.html +++ b/man/tip/nng_dialer_id.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_id(3) --- <h1>nng_dialer_id(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_id</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_dialer_set.3.html b/man/tip/nng_dialer_set.3.html index c2b80327..5d57aaab 100644 --- a/man/tip/nng_dialer_set.3.html +++ b/man/tip/nng_dialer_set.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_set(3) --- <h1>nng_dialer_set(3)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_set</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">valsz</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_set</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">valsz</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_set_bool</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">bval</span><span class="tok-p">);</span> @@ -29,11 +30,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_set_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">ptr</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_set_string</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</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">str</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -48,8 +49,7 @@ The actual options that may be configured in this way vary, and many are documented in <a href="nng_options.5.html">nng_options(5)</a>.</p> </div> <div class="paragraph"> -<p>Additionally some transport-specific options are documented with the -transports themselves.</p> +<p>Additionally some transport-specific options are documented with the transports themselves.</p> </div> <div class="admonitionblock note"> <table> diff --git a/man/tip/nng_dialer_setopt.3.html b/man/tip/nng_dialer_setopt.3.html index cd0d677c..ac60db70 100644 --- a/man/tip/nng_dialer_setopt.3.html +++ b/man/tip/nng_dialer_setopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_setopt(3) --- <h1>nng_dialer_setopt(3)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_setopt</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">valsz</span><span class="tok-p">);</span> + <span class="tok-kt">size_t</span> <span class="tok-n">valsz</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_setopt_bool</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">bval</span><span class="tok-p">);</span> @@ -29,11 +30,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_setopt_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">ptr</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_setopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_setopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_setopt_string</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</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">str</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_setopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_setopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -41,14 +42,15 @@ layout: manpage_v2 <div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> -<div class="admonitionblock note"> +<div class="admonitionblock important"> <table> <tr> <td class="icon"> -<i class="fa icon-note" title="Note"></i> +<i class="fa icon-important" title="Important"></i> </td> <td class="content"> These functions are deprecated. Please see <a href="nng_dialer_set.3.html">nng_dialer_set</a>. +They may not be present if the library was built with <code>NNG_ELIDE_DEPRECATED</code>. </td> </tr> </table> diff --git a/man/tip/nng_dialer_start.3.html b/man/tip/nng_dialer_start.3.html index 6adfd846..68ff2b65 100644 --- a/man/tip/nng_dialer_start.3.html +++ b/man/tip/nng_dialer_start.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_start(3) --- <h1>nng_dialer_start(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_start</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</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> </div> </div> diff --git a/man/tip/nng_duration.5.html b/man/tip/nng_duration.5.html index fc812b04..31100ea7 100644 --- a/man/tip/nng_duration.5.html +++ b/man/tip/nng_duration.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_duration(5) --- <h1>nng_duration(5)</h1> <div class="sect1"> @@ -16,13 +17,13 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-k">typedef</span> <span class="tok-n">int32_t</span> <span class="tok-n">nng_duration</span><span class="tok-p">;</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> -<span class="tok-cp">#define NNG_DURATION_INFINITE (-1) -</span><span class="tok-cp">#define NNG_DURATION_DEFAULT (-2) -</span><span class="tok-cp">#define NNG_DURATION_ZERO (0)</span></code></pre> +<span class="tok-k">typedef</span> <span class="tok-kt">int32_t</span> <span class="tok-n">nng_duration</span><span class="tok-p">;</span> + +<span class="tok-cp">#define NNG_DURATION_INFINITE (-1)</span> +<span class="tok-cp">#define NNG_DURATION_DEFAULT (-2)</span> +<span class="tok-cp">#define NNG_DURATION_ZERO (0)</span></code></pre> </div> </div> </div> @@ -43,8 +44,7 @@ This type is most often used in conjunction with timers and timeouts.</p> <dt class="hdlist1"><code>NNG_DURATION_DEFAULT</code></dt> <dd> <p>Indicates a context-specific default value should be used.</p> -<div class="dlist"> -<dl> +</dd> <dt class="hdlist1"><code>NNG_DURATION_INFINITE</code></dt> <dd> <p>Effectively an infinite duration; used most often to disable timeouts.</p> @@ -55,9 +55,6 @@ This type is most often used in conjunction with timers and timeouts.</p> </dd> </dl> </div> -</dd> -</dl> -</div> </div> </div> <div class="sect1"> diff --git a/man/tip/nng_free.3.html b/man/tip/nng_free.3.html index ad0390ef..e5b94cbf 100644 --- a/man/tip/nng_free.3.html +++ b/man/tip/nng_free.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_free(3) --- <h1>nng_free(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">void</span> <span class="tok-nf">nng_free</span><span class="tok-p">(</span><span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">ptr</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">void</span> <span class="tok-nf">nng_free</span><span class="tok-p">(</span><span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">ptr</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> </div> </div> </div> @@ -53,7 +54,7 @@ used to allocate the memory. <td class="content"> Do not attempt to use this function to deallocate memory obtained by a call to the system <code>malloc()</code> or <code>calloc()</code> functions, -or the C++ <code>new</code> operator. +or the C++ <code>new</code> operator. Doing so may result in unpredictable behavior, including corruption of application memory. </td> diff --git a/man/tip/nng_getopt.3.html b/man/tip/nng_getopt.3.html index 9bd3aefa..84cfbcde 100644 --- a/man/tip/nng_getopt.3.html +++ b/man/tip/nng_getopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_getopt(3) --- <h1>nng_getopt(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_getopt</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_getopt</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</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">valszp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_getopt_bool</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span> @@ -28,11 +29,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_getopt_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">ptr</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_getopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_getopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_getopt_string</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_getopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_getopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -40,14 +41,15 @@ layout: manpage_v2 <div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> -<div class="admonitionblock note"> +<div class="admonitionblock important"> <table> <tr> <td class="icon"> -<i class="fa icon-note" title="Note"></i> +<i class="fa icon-important" title="Important"></i> </td> <td class="content"> These functions are deprecated. Please see <a href="nng_socket_get.3.html">nng_socket_get</a>. +They may not be present if the library was built with <code>NNG_ELIDE_DEPRECATED</code>. </td> </tr> </table> diff --git a/man/tip/nng_http_client_alloc.3http.html b/man/tip/nng_http_client_alloc.3http.html index 9cba3ebf..d11ae1bc 100644 --- a/man/tip/nng_http_client_alloc.3http.html +++ b/man/tip/nng_http_client_alloc.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_alloc(3http) --- <h1>nng_http_client_alloc(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_client_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_http_client</span> <span class="tok-o">*</span><span class="tok-n">clientp</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_url</span> <span class="tok-o">*</span><span class="tok-n">url</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_client_connect.3http.html b/man/tip/nng_http_client_connect.3http.html index 13a9d27e..e44009e5 100644 --- a/man/tip/nng_http_client_connect.3http.html +++ b/man/tip/nng_http_client_connect.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_connect(3http) --- <h1>nng_http_client_connect(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_client_connect</span><span class="tok-p">(</span><span class="tok-n">nng_http_client</span> <span class="tok-o">*</span><span class="tok-n">client</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -114,25 +115,30 @@ obtained by <span class="tok-kt">int</span> <span class="tok-n">rv</span><span class="tok-p">;</span> <span class="tok-c1">// Error checks elided for clarity. -</span><span class="tok-c1"></span> <span class="tok-n">nng_url_parse</span><span class="tok-p">(</span><span class="tok-o">&</span><span class="tok-n">url</span><span class="tok-p">,</span> <span class="tok-s">"http://www.google.com"</span><span class="tok-p">);</span> - <span class="tok-n">nng_aio_alloc</span><span class="tok-p">(</span><span class="tok-o">&</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-nb">NULL</span><span class="tok-p">,</span> <span class="tok-nb">NULL</span><span class="tok-p">);</span> - <span class="tok-n">nng_http_client_alloc</span><span class="tok-p">(</span><span class="tok-o">&</span><span class="tok-n">client</span><span class="tok-p">,</span> <span class="tok-n">url</span><span class="tok-p">);</span> +</span> + <span class="tok-nf">nng_url_parse</span><span class="tok-p">(</span><span class="tok-o">&</span><span class="tok-n">url</span><span class="tok-p">,</span> <span class="tok-s">"http://www.google.com"</span><span class="tok-p">);</span> + <span class="tok-nf">nng_aio_alloc</span><span class="tok-p">(</span><span class="tok-o">&</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-nb">NULL</span><span class="tok-p">,</span> <span class="tok-nb">NULL</span><span class="tok-p">);</span> + <span class="tok-nf">nng_http_client_alloc</span><span class="tok-p">(</span><span class="tok-o">&</span><span class="tok-n">client</span><span class="tok-p">,</span> <span class="tok-n">url</span><span class="tok-p">);</span> - <span class="tok-n">nng_http_client_connect</span><span class="tok-p">(</span><span class="tok-n">client</span><span class="tok-p">,</span> <span class="tok-n">aio</span><span class="tok-p">);</span> + <span class="tok-nf">nng_http_client_connect</span><span class="tok-p">(</span><span class="tok-n">client</span><span class="tok-p">,</span> <span class="tok-n">aio</span><span class="tok-p">);</span> <span class="tok-c1">// Wait for connection to establish (or attempt to fail). -</span><span class="tok-c1"></span> <span class="tok-n">nng_aio_wait</span><span class="tok-p">(</span><span class="tok-n">aio</span><span class="tok-p">);</span> +</span> + <span class="tok-nf">nng_aio_wait</span><span class="tok-p">(</span><span class="tok-n">aio</span><span class="tok-p">);</span> - <span class="tok-k">if</span> <span class="tok-p">((</span><span class="tok-n">rv</span> <span class="tok-o">=</span> <span class="tok-n">nng_aio_result</span><span class="tok-p">(</span><span class="tok-n">aio</span><span class="tok-p">))</span> <span class="tok-o">!=</span> <span class="tok-mi">0</span><span class="tok-p">)</span> <span class="tok-p">{</span> - <span class="tok-n">printf</span><span class="tok-p">(</span><span class="tok-s">"Connection failed: %s</span><span class="tok-se">\n</span><span class="tok-s">"</span><span class="tok-p">,</span> <span class="tok-n">nng_strerror</span><span class="tok-p">(</span><span class="tok-n">rv</span><span class="tok-p">));</span> + <span class="tok-k">if</span> <span class="tok-p">((</span><span class="tok-n">rv</span> <span class="tok-o">=</span> <span class="tok-nf">nng_aio_result</span><span class="tok-p">(</span><span class="tok-n">aio</span><span class="tok-p">))</span> <span class="tok-o">!=</span> <span class="tok-mi">0</span><span class="tok-p">)</span> <span class="tok-p">{</span> + <span class="tok-nf">printf</span><span class="tok-p">(</span><span class="tok-s">"Connection failed: %s</span><span class="tok-se">\n</span><span class="tok-s">"</span><span class="tok-p">,</span> <span class="tok-nf">nng_strerror</span><span class="tok-p">(</span><span class="tok-n">rv</span><span class="tok-p">));</span> <span class="tok-p">}</span> <span class="tok-k">else</span> <span class="tok-p">{</span> <span class="tok-c1">// Connection established, get it. -</span><span class="tok-c1"></span> <span class="tok-n">conn</span> <span class="tok-o">=</span> <span class="tok-n">nng_aio_get_output</span><span class="tok-p">(</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-mi">0</span><span class="tok-p">);</span> +</span> + <span class="tok-n">conn</span> <span class="tok-o">=</span> <span class="tok-nf">nng_aio_get_output</span><span class="tok-p">(</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-mi">0</span><span class="tok-p">);</span> <span class="tok-c1">// ... do something with it here -</span><span class="tok-c1"></span> +</span> + <span class="tok-c1">// Close the connection when done to avoid leaking it. -</span><span class="tok-c1"></span> <span class="tok-n">nng_http_conn_close</span><span class="tok-p">(</span><span class="tok-n">conn</span><span class="tok-p">);</span> +</span> + <span class="tok-nf">nng_http_conn_close</span><span class="tok-p">(</span><span class="tok-n">conn</span><span class="tok-p">);</span> <span class="tok-p">}</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_client_free.3http.html b/man/tip/nng_http_client_free.3http.html index a61ff119..64abfb6d 100644 --- a/man/tip/nng_http_client_free.3http.html +++ b/man/tip/nng_http_client_free.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_free(3http) --- <h1>nng_http_client_free(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_client_free</span><span class="tok-p">(</span><span class="tok-n">nng_http_client</span> <span class="tok-o">*</span><span class="tok-n">client</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_client_get_tls.3http.html b/man/tip/nng_http_client_get_tls.3http.html index 83e5a1f5..8b3d545b 100644 --- a/man/tip/nng_http_client_get_tls.3http.html +++ b/man/tip/nng_http_client_get_tls.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_get_tls(3http) --- <h1>nng_http_client_get_tls(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_client_get_tls</span><span class="tok-p">(</span><span class="tok-n">nng_http_client</span> <span class="tok-o">*</span><span class="tok-n">client</span><span class="tok-p">,</span> <span class="tok-n">nng_tls_config</span> <span class="tok-o">**</span><span class="tok-n">cfgp</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_client_set_tls.3http.html b/man/tip/nng_http_client_set_tls.3http.html index 3fa775b2..1a587ef2 100644 --- a/man/tip/nng_http_client_set_tls.3http.html +++ b/man/tip/nng_http_client_set_tls.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_set_tls(3http) --- <h1>nng_http_client_set_tls(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_client_set_tls</span><span class="tok-p">(</span><span class="tok-n">nng_http_client</span> <span class="tok-o">*</span><span class="tok-n">client</span><span class="tok-p">,</span> <span class="tok-n">nng_tls_config</span> <span class="tok-o">*</span><span class="tok-n">cfg</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_client_transact.3http.html b/man/tip/nng_http_client_transact.3http.html index f1985ab3..3b883472 100644 --- a/man/tip/nng_http_client_transact.3http.html +++ b/man/tip/nng_http_client_transact.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_transact(3http) --- <h1>nng_http_client_transact(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_client_transact</span><span class="tok-p">(</span><span class="tok-n">nng_http_client</span> <span class="tok-o">*</span><span class="tok-n">client</span><span class="tok-p">,</span> <span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">,</span> <span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_http_conn_close.3http.html b/man/tip/nng_http_conn_close.3http.html index fd995599..05b75d82 100644 --- a/man/tip/nng_http_conn_close.3http.html +++ b/man/tip/nng_http_conn_close.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_close(3http) --- <h1>nng_http_conn_close(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_conn_close</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_conn_read.3http.html b/man/tip/nng_http_conn_read.3http.html index b1bd0d53..9e618d8b 100644 --- a/man/tip/nng_http_conn_read.3http.html +++ b/man/tip/nng_http_conn_read.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_read(3http) --- <h1>nng_http_conn_read(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_conn_read</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_conn_read_all.3http.html b/man/tip/nng_http_conn_read_all.3http.html index 00246474..c101bdf1 100644 --- a/man/tip/nng_http_conn_read_all.3http.html +++ b/man/tip/nng_http_conn_read_all.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_read_all(3http) --- <h1>nng_http_conn_read_all(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_conn_read_all</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_conn_read_req.3http.html b/man/tip/nng_http_conn_read_req.3http.html index 220dedbb..fa4f959d 100644 --- a/man/tip/nng_http_conn_read_req.3http.html +++ b/man/tip/nng_http_conn_read_req.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_read_req(3http) --- <h1>nng_http_conn_read_req(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_conn_read_req</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">,</span> <span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_http_conn_read_res.3http.html b/man/tip/nng_http_conn_read_res.3http.html index 472f7656..9132169f 100644 --- a/man/tip/nng_http_conn_read_res.3http.html +++ b/man/tip/nng_http_conn_read_res.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_read_res(3http) --- <h1>nng_http_conn_read_res(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_conn_read_res</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">,</span> <span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_http_conn_transact.3http.html b/man/tip/nng_http_conn_transact.3http.html index e8cd4b00..5f72c8cc 100644 --- a/man/tip/nng_http_conn_transact.3http.html +++ b/man/tip/nng_http_conn_transact.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_transact(3http) --- <h1>nng_http_conn_transact(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_conn_transact</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">,</span> <span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">,</span> <span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_http_conn_write.3http.html b/man/tip/nng_http_conn_write.3http.html index b4465ae6..06069e00 100644 --- a/man/tip/nng_http_conn_write.3http.html +++ b/man/tip/nng_http_conn_write.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_write(3http) --- <h1>nng_http_conn_write(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_conn_write</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_conn_write_all.3http.html b/man/tip/nng_http_conn_write_all.3http.html index 3ff311aa..f1e7d663 100644 --- a/man/tip/nng_http_conn_write_all.3http.html +++ b/man/tip/nng_http_conn_write_all.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_write_all(3http) --- <h1>nng_http_conn_write_all(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_conn_write_all</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_conn_write_req.3http.html b/man/tip/nng_http_conn_write_req.3http.html index e9bdad4a..455770f8 100644 --- a/man/tip/nng_http_conn_write_req.3http.html +++ b/man/tip/nng_http_conn_write_req.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_write_req(3http) --- <h1>nng_http_conn_write_req(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_conn_write_req</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">,</span> <span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_http_conn_write_res.3http.html b/man/tip/nng_http_conn_write_res.3http.html index b0946a06..3ae9c946 100644 --- a/man/tip/nng_http_conn_write_res.3http.html +++ b/man/tip/nng_http_conn_write_res.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_write_res(3http) --- <h1>nng_http_conn_write_res(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_conn_write_res</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">,</span> <span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_http_handler_alloc.3http.html b/man/tip/nng_http_handler_alloc.3http.html index 9b68cc64..89cd6e76 100644 --- a/man/tip/nng_http_handler_alloc.3http.html +++ b/man/tip/nng_http_handler_alloc.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_alloc(3http) --- <h1>nng_http_handler_alloc(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_http_handler</span> <span class="tok-n">nng_http_handler</span><span class="tok-p">;</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_http_handler_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">**</span><span class="tok-n">hp</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">path</span><span class="tok-p">,</span> @@ -31,10 +32,10 @@ layout: manpage_v2 <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">filename</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_http_handler_alloc_redirect</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">**</span><span class="tok-n">hp</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">path</span><span class="tok-p">,</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">status</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">location</span><span class="tok-p">);</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">status</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">location</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_http_handler_alloc_static</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">**</span><span class="tok-n">hp</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">path</span><span class="tok-p">,</span> - <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">size</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">content_type</span><span class="tok-p">);</span></code></pre> + <span class="tok-k">const</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-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">content_type</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -58,7 +59,7 @@ considered when determining whether the handler should be called.</p> <p>Additionally each handler has a method it is registered to handle (the default is <code>GET</code>, see <a href="nng_http_handler_set_method.3http.html"><code>nng_http_handler_set_method()</code></a>), and -optionally a 'Host' header it can be matched against (see +optionally a 'Host' header it can be matched against (see <a href="nng_http_handler_set_host.3http.html"><code>nng_http_handler_set_host()</code></a>).</p> </div> <div class="paragraph"> diff --git a/man/tip/nng_http_handler_collect_body.3http.html b/man/tip/nng_http_handler_collect_body.3http.html index 08ffbfb1..2d200e6c 100644 --- a/man/tip/nng_http_handler_collect_body.3http.html +++ b/man/tip/nng_http_handler_collect_body.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_collect_body(3http) --- <h1>nng_http_handler_collect_body(3http)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_http_handler_collect_body</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">*</span><span class="tok-n">handler</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">want</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">maxsz</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_http_handler_collect_body</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">*</span><span class="tok-n">handler</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">want</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">maxsz</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_http_handler_free.3http.html b/man/tip/nng_http_handler_free.3http.html index 6a9150d8..7625e799 100644 --- a/man/tip/nng_http_handler_free.3http.html +++ b/man/tip/nng_http_handler_free.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_free(3http) --- <h1>nng_http_handler_free(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_handler_free</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">*</span><span class="tok-n">h</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_handler_get_data.3http.html b/man/tip/nng_http_handler_get_data.3http.html index 3396c682..79fef724 100644 --- a/man/tip/nng_http_handler_get_data.3http.html +++ b/man/tip/nng_http_handler_get_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_get_data(3http) --- <h1>nng_http_handler_get_data(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-nf">nng_http_handler_get_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">*</span><span class="tok-n">handler</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_handler_set_data.3http.html b/man/tip/nng_http_handler_set_data.3http.html index c11fdd4c..4ff53cfa 100644 --- a/man/tip/nng_http_handler_set_data.3http.html +++ b/man/tip/nng_http_handler_set_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_set_data(3http) --- <h1>nng_http_handler_set_data(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_handler_set_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">*</span><span class="tok-n">handler</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">void</span> <span class="tok-p">(</span><span class="tok-o">*</span><span class="tok-n">dtor</span><span class="tok-p">)(</span><span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-p">));</span></code></pre> </div> diff --git a/man/tip/nng_http_handler_set_host.3http.html b/man/tip/nng_http_handler_set_host.3http.html index 07f4ca70..3e8c1138 100644 --- a/man/tip/nng_http_handler_set_host.3http.html +++ b/man/tip/nng_http_handler_set_host.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_set_host(3http) --- <h1>nng_http_handler_set_host(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_handler_set_host</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">*</span><span class="tok-n">handler</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">host</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_handler_set_method.3http.html b/man/tip/nng_http_handler_set_method.3http.html index 4062a557..f45233e6 100644 --- a/man/tip/nng_http_handler_set_method.3http.html +++ b/man/tip/nng_http_handler_set_method.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_set_method(3http) --- <h1>nng_http_handler_set_method(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_handler_set_method</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">*</span><span class="tok-n">handler</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">method</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -29,8 +30,8 @@ layout: manpage_v2 <div class="sectionbody"> <div class="paragraph"> <p>The <code>nng_http_handler_set_method()</code> function sets the <em>method</em> that the -<em>handler</em> will be called for, such as "GET" or "POST". -(By default the "GET" method is handled.) +<em>handler</em> will be called for, such as "GET" or "POST". +(By default the "GET" method is handled.) If <em>method</em> is <code>NULL</code>, then the request method is not examined, and the handler will be executed regardless of the method.</p> @@ -42,8 +43,8 @@ method.</p> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> -The server will automatically call "GET" handlers if the client -sends a "HEAD" request, and will suppress HTTP body data in the responses +The server will automatically call "GET" handlers if the client +sends a "HEAD" request, and will suppress HTTP body data in the responses sent for such requests. </td> </tr> diff --git a/man/tip/nng_http_handler_set_tree.3http.html b/man/tip/nng_http_handler_set_tree.3http.html index 3d10221c..4dbdd8fe 100644 --- a/man/tip/nng_http_handler_set_tree.3http.html +++ b/man/tip/nng_http_handler_set_tree.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_set_tree(3http) --- <h1>nng_http_handler_set_tree(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_handler_set_tree</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">*</span><span class="tok-n">handler</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_http_handler_set_tree_exclusive</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span> <span class="tok-o">*</span><span class="tok-n">handler</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_http_hijack.3http.html b/man/tip/nng_http_hijack.3http.html index 60844405..fbb8fee1 100644 --- a/man/tip/nng_http_hijack.3http.html +++ b/man/tip/nng_http_hijack.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_hijack(3http) --- <h1>nng_http_hijack(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_hijack</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_req_add_header.3http.html b/man/tip/nng_http_req_add_header.3http.html index 1eb8547c..e7af8c13 100644 --- a/man/tip/nng_http_req_add_header.3http.html +++ b/man/tip/nng_http_req_add_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_add_header(3http) --- <h1>nng_http_req_add_header(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_add_header</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</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">key</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">val</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_http_req_alloc.3http.html b/man/tip/nng_http_req_alloc.3http.html index 963aac5c..63d5e719 100644 --- a/man/tip/nng_http_req_alloc.3http.html +++ b/man/tip/nng_http_req_alloc.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_alloc(3http) --- <h1>nng_http_req_alloc(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">**</span><span class="tok-n">reqp</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_url</span> <span class="tok-o">*</span><span class="tok-n">url</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_req_copy_data.3http.html b/man/tip/nng_http_req_copy_data.3http.html index d26f7e0d..1fdc3226 100644 --- a/man/tip/nng_http_req_copy_data.3http.html +++ b/man/tip/nng_http_req_copy_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_copy_data(3http) --- <h1>nng_http_req_copy_data(3http)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_copy_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">body</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_copy_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">body</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> </div> </div> </div> diff --git a/man/tip/nng_http_req_del_header.3http.html b/man/tip/nng_http_req_del_header.3http.html index 1874efeb..39065466 100644 --- a/man/tip/nng_http_req_del_header.3http.html +++ b/man/tip/nng_http_req_del_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_del_header(3http) --- <h1>nng_http_req_del_header(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_del_header</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</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">key</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_req_free.3http.html b/man/tip/nng_http_req_free.3http.html index 63228e2f..168bd434 100644 --- a/man/tip/nng_http_req_free.3http.html +++ b/man/tip/nng_http_req_free.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_free(3http) --- <h1>nng_http_req_free(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_req_free</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_req_get_data.3http.html b/man/tip/nng_http_req_get_data.3http.html index 1e1b52cf..b1e5931a 100644 --- a/man/tip/nng_http_req_get_data.3http.html +++ b/man/tip/nng_http_req_get_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_get_data(3http) --- <h1>nng_http_req_get_data(3http)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">void</span> <span class="tok-nf">nng_http_req_get_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">bodyp</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">sizep</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + +<span class="tok-kt">void</span> <span class="tok-nf">nng_http_req_get_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">bodyp</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">sizep</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_http_req_get_header.3http.html b/man/tip/nng_http_req_get_header.3http.html index e3759f6d..a5470296 100644 --- a/man/tip/nng_http_req_get_header.3http.html +++ b/man/tip/nng_http_req_get_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_get_header(3http) --- <h1>nng_http_req_get_header(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-nf">nng_http_req_get_header</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</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">key</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_req_get_method.3http.html b/man/tip/nng_http_req_get_method.3http.html index 5640af89..df575784 100644 --- a/man/tip/nng_http_req_get_method.3http.html +++ b/man/tip/nng_http_req_get_method.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_get_method(3http) --- <h1>nng_http_req_get_method(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-nf">nng_http_req_get_method</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -30,7 +31,7 @@ layout: manpage_v2 <div class="paragraph"> <p>The <code>nng_http_req_get_method()</code> returns the HTTP method associated with the request <em>req</em>. -The value will be a string, such as "GET" or "POST".</p> +The value will be a string, such as "GET" or "POST".</p> </div> </div> </div> diff --git a/man/tip/nng_http_req_get_uri.3http.html b/man/tip/nng_http_req_get_uri.3http.html index d2fdb5ef..9a5a12ea 100644 --- a/man/tip/nng_http_req_get_uri.3http.html +++ b/man/tip/nng_http_req_get_uri.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_get_uri(3http) --- <h1>nng_http_req_get_uri(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-nf">nng_http_req_get_uri</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_req_get_version.3http.html b/man/tip/nng_http_req_get_version.3http.html index b333ec3e..0adfec6f 100644 --- a/man/tip/nng_http_req_get_version.3http.html +++ b/man/tip/nng_http_req_get_version.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_get_version(3http) --- <h1>nng_http_req_get_version(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-nf">nng_http_req_get_version</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -29,7 +30,7 @@ layout: manpage_v2 <div class="sectionbody"> <div class="paragraph"> <p>The <code>nng_http_req_get_version()</code> returns a string representing the HTTP -protocol version associated with the request <em>req</em>, such as "HTTP/1.1".</p> +protocol version associated with the request <em>req</em>, such as "HTTP/1.1".</p> </div> </div> </div> diff --git a/man/tip/nng_http_req_reset.3http.html b/man/tip/nng_http_req_reset.3http.html index 6a3b1ab1..d7984f66 100644 --- a/man/tip/nng_http_req_reset.3http.html +++ b/man/tip/nng_http_req_reset.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_reset(3http) --- <h1>nng_http_req_reset(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_req_reset</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_req_set_data.3http.html b/man/tip/nng_http_req_set_data.3http.html index 9e98bb30..7d6f0b45 100644 --- a/man/tip/nng_http_req_set_data.3http.html +++ b/man/tip/nng_http_req_set_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_set_data(3http) --- <h1>nng_http_req_set_data(3http)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_set_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">body</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_set_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">body</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> </div> </div> </div> diff --git a/man/tip/nng_http_req_set_header.3http.html b/man/tip/nng_http_req_set_header.3http.html index 41fae4e3..6eacd2c3 100644 --- a/man/tip/nng_http_req_set_header.3http.html +++ b/man/tip/nng_http_req_set_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_set_header(3http) --- <h1>nng_http_req_set_header(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_set_header</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</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">key</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">val</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_http_req_set_method.3http.html b/man/tip/nng_http_req_set_method.3http.html index 74270b09..d40a3c93 100644 --- a/man/tip/nng_http_req_set_method.3http.html +++ b/man/tip/nng_http_req_set_method.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_set_method(3http) --- <h1>nng_http_req_set_method(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_set_method</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</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">method</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -30,11 +31,11 @@ layout: manpage_v2 <div class="paragraph"> <p>The <code>nng_http_req_set_method()</code> sets the HTTP method associated with the request <em>req</em> to <em>method</em>. The <em>method</em> must be a string, -such as "GET" or "POST", and the HTTP specifications indicate that it must +such as "GET" or "POST", and the HTTP specifications indicate that it must be upper case.</p> </div> <div class="paragraph"> -<p>The default value method for newly allocated requests is "GET".</p> +<p>The default value method for newly allocated requests is "GET".</p> </div> <div class="paragraph"> <p>A local copy of the <em>method</em> is made in the request <em>req</em>.</p> diff --git a/man/tip/nng_http_req_set_uri.3http.html b/man/tip/nng_http_req_set_uri.3http.html index 796e0979..62b515ae 100644 --- a/man/tip/nng_http_req_set_uri.3http.html +++ b/man/tip/nng_http_req_set_uri.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_set_uri(3http) --- <h1>nng_http_req_set_uri(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_set_uri</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</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">uri</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_req_set_version.3http.html b/man/tip/nng_http_req_set_version.3http.html index b11e8bc7..4afacea8 100644 --- a/man/tip/nng_http_req_set_version.3http.html +++ b/man/tip/nng_http_req_set_version.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_set_version(3http) --- <h1>nng_http_req_set_version(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_set_version</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">*</span><span class="tok-n">req</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">version</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -31,8 +32,8 @@ layout: manpage_v2 <p>The <code>nng_http_req_set_version()</code> sets the HTTP protocol version associated with the request <em>req</em> to <em>version</em>. The <em>version</em> must be a string containing -a valid HTTP protocol version, such as "HTTP/1.0". -The default value is "HTTP/1.1".</p> +a valid HTTP protocol version, such as "HTTP/1.0". +The default value is "HTTP/1.1".</p> </div> <div class="paragraph"> <p>A local copy of the <em>version</em> is made in the request <em>req</em>.</p> @@ -57,7 +58,7 @@ No validation of the version supplied is performed. </td> <td class="content"> The library does not contain support for versions of HTTP other than -"HTTP/1.0" and "HTTP/1.1". +"HTTP/1.0" and "HTTP/1.1". Specifying any other version may result in unspecified behavior. </td> </tr> diff --git a/man/tip/nng_http_res_add_header.3http.html b/man/tip/nng_http_res_add_header.3http.html index b50fc473..58860793 100644 --- a/man/tip/nng_http_res_add_header.3http.html +++ b/man/tip/nng_http_res_add_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_add_header(3http) --- <h1>nng_http_res_add_header(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_add_header</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</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">key</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">val</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_http_res_alloc.3http.html b/man/tip/nng_http_res_alloc.3http.html index 47ff32d0..4d3e48c9 100644 --- a/man/tip/nng_http_res_alloc.3http.html +++ b/man/tip/nng_http_res_alloc.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_alloc(3http) --- <h1>nng_http_res_alloc(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">**</span><span class="tok-n">resp</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_res_alloc_error.3http.html b/man/tip/nng_http_res_alloc_error.3http.html index 35d69de2..32457382 100644 --- a/man/tip/nng_http_res_alloc_error.3http.html +++ b/man/tip/nng_http_res_alloc_error.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_alloc_error(3http) --- <h1>nng_http_res_alloc_error(3http)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_alloc_error</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">**</span><span class="tok-n">resp</span><span class="tok-p">,</span> <span class="tok-n">uint16_t</span> <span class="tok-n">status</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_alloc_error</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">**</span><span class="tok-n">resp</span><span class="tok-p">,</span> <span class="tok-kt">uint16_t</span> <span class="tok-n">status</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -36,7 +37,7 @@ a simple HTML page containing the same information will be generated and attached to the response. (Relevant HTTP headers will be set as well, such as <code>Content-Type</code> and <code>Content-Length</code>.) -The HTTP protocol version is also set to "HTTP/1.1".</p> +The HTTP protocol version is also set to "HTTP/1.1".</p> </div> <div class="admonitionblock tip"> <table> diff --git a/man/tip/nng_http_res_copy_data.3http.html b/man/tip/nng_http_res_copy_data.3http.html index eec3510f..9622b1e1 100644 --- a/man/tip/nng_http_res_copy_data.3http.html +++ b/man/tip/nng_http_res_copy_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_copy_data(3http) --- <h1>nng_http_res_copy_data(3http)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_copy_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">body</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_copy_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">body</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> </div> </div> </div> diff --git a/man/tip/nng_http_res_del_header.3http.html b/man/tip/nng_http_res_del_header.3http.html index c5217922..d887bab5 100644 --- a/man/tip/nng_http_res_del_header.3http.html +++ b/man/tip/nng_http_res_del_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_del_header(3http) --- <h1>nng_http_res_del_header(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_del_header</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</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">key</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_res_free.3http.html b/man/tip/nng_http_res_free.3http.html index 85c36f7c..cb245599 100644 --- a/man/tip/nng_http_res_free.3http.html +++ b/man/tip/nng_http_res_free.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_free(3http) --- <h1>nng_http_res_free(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_res_free</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">req</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_res_get_data.3http.html b/man/tip/nng_http_res_get_data.3http.html index a899854c..9a2a06ad 100644 --- a/man/tip/nng_http_res_get_data.3http.html +++ b/man/tip/nng_http_res_get_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_get_data(3http) --- <h1>nng_http_res_get_data(3http)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">void</span> <span class="tok-nf">nng_http_res_get_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">bodyp</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">sizep</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + +<span class="tok-kt">void</span> <span class="tok-nf">nng_http_res_get_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">bodyp</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">sizep</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_http_res_get_header.3http.html b/man/tip/nng_http_res_get_header.3http.html index dcc65cc1..9102ad29 100644 --- a/man/tip/nng_http_res_get_header.3http.html +++ b/man/tip/nng_http_res_get_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_get_header(3http) --- <h1>nng_http_res_get_header(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-nf">nng_http_res_get_header</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</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">key</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_res_get_reason.3http.html b/man/tip/nng_http_res_get_reason.3http.html index e985c7b0..4a5f4162 100644 --- a/man/tip/nng_http_res_get_reason.3http.html +++ b/man/tip/nng_http_res_get_reason.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_get_reason(3http) --- <h1>nng_http_res_get_reason(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-nf">nng_http_res_get_reason</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_res_get_status.3http.html b/man/tip/nng_http_res_get_status.3http.html index 7f8ca842..259b5ea0 100644 --- a/man/tip/nng_http_res_get_status.3http.html +++ b/man/tip/nng_http_res_get_status.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_get_status(3http) --- <h1>nng_http_res_get_status(3http)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-n">uint16_t</span> <span class="tok-nf">nng_http_res_get_status</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + +<span class="tok-kt">uint16_t</span> <span class="tok-nf">nng_http_res_get_status</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_http_res_get_version.3http.html b/man/tip/nng_http_res_get_version.3http.html index ad1156f8..f8cf0ff7 100644 --- a/man/tip/nng_http_res_get_version.3http.html +++ b/man/tip/nng_http_res_get_version.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_get_version(3http) --- <h1>nng_http_res_get_version(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-nf">nng_http_res_get_version</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -29,7 +30,7 @@ layout: manpage_v2 <div class="sectionbody"> <div class="paragraph"> <p>The <code>nng_http_res_get_version()</code> returns a string representing the HTTP -protocol version associated with the request <em>res</em>, such as "HTTP/1.1".</p> +protocol version associated with the request <em>res</em>, such as "HTTP/1.1".</p> </div> </div> </div> diff --git a/man/tip/nng_http_res_reset.3http.html b/man/tip/nng_http_res_reset.3http.html index 1947bbd3..b8e345b9 100644 --- a/man/tip/nng_http_res_reset.3http.html +++ b/man/tip/nng_http_res_reset.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_reset(3http) --- <h1>nng_http_res_reset(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_res_reset</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_res_set_data.3http.html b/man/tip/nng_http_res_set_data.3http.html index 9e426dd6..257e185e 100644 --- a/man/tip/nng_http_res_set_data.3http.html +++ b/man/tip/nng_http_res_set_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_set_data(3http) --- <h1>nng_http_res_set_data(3http)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_set_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">body</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_set_data</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">body</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> </div> </div> </div> diff --git a/man/tip/nng_http_res_set_header.3http.html b/man/tip/nng_http_res_set_header.3http.html index 7bd7ebfd..fc888922 100644 --- a/man/tip/nng_http_res_set_header.3http.html +++ b/man/tip/nng_http_res_set_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_set_header(3http) --- <h1>nng_http_res_set_header(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_set_header</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</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">key</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">val</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_http_res_set_reason.3http.html b/man/tip/nng_http_res_set_reason.3http.html index 22d3309b..105dcc5e 100644 --- a/man/tip/nng_http_res_set_reason.3http.html +++ b/man/tip/nng_http_res_set_reason.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_set_reason(3http) --- <h1>nng_http_res_set_reason(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_set_reason</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</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">reason</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_res_set_status.3http.html b/man/tip/nng_http_res_set_status.3http.html index de753733..edda0df5 100644 --- a/man/tip/nng_http_res_set_status.3http.html +++ b/man/tip/nng_http_res_set_status.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_set_status(3http) --- <h1>nng_http_res_set_status(3http)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_set_status</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-n">uint16_t</span> <span class="tok-n">status</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_set_status</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">,</span> <span class="tok-kt">uint16_t</span> <span class="tok-n">status</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_http_res_set_version.3http.html b/man/tip/nng_http_res_set_version.3http.html index 35ab91b1..453f4f20 100644 --- a/man/tip/nng_http_res_set_version.3http.html +++ b/man/tip/nng_http_res_set_version.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_set_version(3http) --- <h1>nng_http_res_set_version(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_res_set_version</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</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">version</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -31,8 +32,8 @@ layout: manpage_v2 <p>The <code>nng_http_res_set_version()</code> sets the HTTP protocol version associated with the response <em>res</em> to <em>version</em>. The <em>version</em> must be a string containing -a valid HTTP protocol version, such as "HTTP/1.0". -The default value is "HTTP/1.1".</p> +a valid HTTP protocol version, such as "HTTP/1.0". +The default value is "HTTP/1.1".</p> </div> <div class="paragraph"> <p>A local copy of the <em>version</em> is made in the response <em>res</em>.</p> @@ -57,7 +58,7 @@ No validation of the version supplied is performed. </td> <td class="content"> The library does not contain support for versions of HTTP other than -"HTTP/1.0" and "HTTP/1.1". +"HTTP/1.0" and "HTTP/1.1". Specifying any other version may result in unspecified behavior. </td> </tr> diff --git a/man/tip/nng_http_server_add_handler.3http.html b/man/tip/nng_http_server_add_handler.3http.html index f6017319..e5906600 100644 --- a/man/tip/nng_http_server_add_handler.3http.html +++ b/man/tip/nng_http_server_add_handler.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_add_handler(3http) --- <h1>nng_http_server_add_handler(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_server_add_handler</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-n">nng_http_handler</span> <span class="tok-o">*</span><span class="tok-n">h</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_server_del_handler.3http.html b/man/tip/nng_http_server_del_handler.3http.html index b50e556c..deb3eade 100644 --- a/man/tip/nng_http_server_del_handler.3http.html +++ b/man/tip/nng_http_server_del_handler.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_del_handler(3http) --- <h1>nng_http_server_del_handler(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_server_del_handler</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-n">nng_http_handler</span> <span class="tok-o">*</span><span class="tok-n">h</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_server_get_addr.3http.html b/man/tip/nng_http_server_get_addr.3http.html index 71e7b324..1807c429 100644 --- a/man/tip/nng_http_server_get_addr.3http.html +++ b/man/tip/nng_http_server_get_addr.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_get_addr(3http) --- <h1>nng_http_server_get_addr(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_server_get_addr</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">server</span><span class="tok-p">,</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">sap</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_server_get_tls.3http.html b/man/tip/nng_http_server_get_tls.3http.html index 2ad0706b..b437fd8d 100644 --- a/man/tip/nng_http_server_get_tls.3http.html +++ b/man/tip/nng_http_server_get_tls.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_get_tls(3http) --- <h1>nng_http_server_get_tls(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_server_get_tls</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-n">nng_tls_config</span> <span class="tok-o">**</span><span class="tok-n">cfgp</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_server_hold.3http.html b/man/tip/nng_http_server_hold.3http.html index c7f1ff68..0058f21c 100644 --- a/man/tip/nng_http_server_hold.3http.html +++ b/man/tip/nng_http_server_hold.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_hold(3http) --- <h1>nng_http_server_hold(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_server_hold</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">**</span><span class="tok-n">serverp</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_url</span> <span class="tok-o">*</span><span class="tok-n">url</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_server_release.3http.html b/man/tip/nng_http_server_release.3http.html index f71c0e88..d1d2197c 100644 --- a/man/tip/nng_http_server_release.3http.html +++ b/man/tip/nng_http_server_release.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_release(3http) --- <h1>nng_http_server_release(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_server_release</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">server</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -36,7 +37,7 @@ that was previously held with <p>This effectively drops the reference count on the server instance. When the reference count drops to zero, then the <em>server</em> and all resources associated with it (e.g. HTTP handlers, connections, etc.) are deallocated. -(If the server is "running" when this occurs, then the server is stopped.)</p> +(If the server is "running" when this occurs, then the server is stopped.)</p> </div> <div class="admonitionblock important"> <table> diff --git a/man/tip/nng_http_server_res_error.3http.html b/man/tip/nng_http_server_res_error.3http.html index e22e0cde..089af340 100644 --- a/man/tip/nng_http_server_res_error.3http.html +++ b/man/tip/nng_http_server_res_error.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_res_error(3http) --- <h1>nng_http_server_res_error(3http)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_http_server_res_error</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">server</span><span class="tok-p">,</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_http_server_res_error</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">server</span><span class="tok-p">,</span> <span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">response</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -30,7 +31,7 @@ layout: manpage_v2 <div class="sectionbody"> <div class="paragraph"> <p>The <code>nng_http_server_res_error()</code> sets the body of <em>response</em> -to <em>server</em>'s error page, which may have been customized using the +to <em>server</em>'s error page, which may have been customized using the <a href="nng_http_server_set_error_file.3http.html"><code>nng_http_server_error_file()</code></a> or <a href="nng_http_server_set_error_page.3http.html"><code>nng_http_server_error_page()</code></a> diff --git a/man/tip/nng_http_server_set_error_file.3http.html b/man/tip/nng_http_server_set_error_file.3http.html index d60d691e..aced4e28 100644 --- a/man/tip/nng_http_server_set_error_file.3http.html +++ b/man/tip/nng_http_server_set_error_file.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_set_error_file(3http) --- <h1>nng_http_server_set_error_file(3http)</h1> <div class="sect1"> @@ -16,11 +17,11 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_server_set_error_file</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">server</span><span class="tok-p">,</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">code</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">path</span><span class="tok-p">);</span></code></pre> + <span class="tok-kt">uint16_t</span> <span class="tok-n">code</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">path</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_http_server_set_error_page.3http.html b/man/tip/nng_http_server_set_error_page.3http.html index 0a08ae28..b5ab9aa3 100644 --- a/man/tip/nng_http_server_set_error_page.3http.html +++ b/man/tip/nng_http_server_set_error_page.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_set_error_page(3http) --- <h1>nng_http_server_set_error_page(3http)</h1> <div class="sect1"> @@ -16,11 +17,11 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_server_set_error_page</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">server</span><span class="tok-p">,</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">code</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">html</span><span class="tok-p">);</span></code></pre> + <span class="tok-kt">uint16_t</span> <span class="tok-n">code</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">html</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_http_server_set_tls.3http.html b/man/tip/nng_http_server_set_tls.3http.html index 7db9bf4d..97c967d1 100644 --- a/man/tip/nng_http_server_set_tls.3http.html +++ b/man/tip/nng_http_server_set_tls.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_set_tls(3http) --- <h1>nng_http_server_set_tls(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_server_set_tls</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-n">nng_tls_config</span> <span class="tok-o">*</span><span class="tok-n">cfg</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_server_start.3http.html b/man/tip/nng_http_server_start.3http.html index a47e36e9..0dff888d 100644 --- a/man/tip/nng_http_server_start.3http.html +++ b/man/tip/nng_http_server_start.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_start(3http) --- <h1>nng_http_server_start(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_http_server_start</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">server</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_http_server_stop.3http.html b/man/tip/nng_http_server_stop.3http.html index 6c0ccb9e..c5c16eee 100644 --- a/man/tip/nng_http_server_stop.3http.html +++ b/man/tip/nng_http_server_stop.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_stop(3http) --- <h1>nng_http_server_stop(3http)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_http_server_stop</span><span class="tok-p">(</span><span class="tok-n">nng_http_server</span> <span class="tok-o">*</span><span class="tok-n">server</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_inproc.7.html b/man/tip/nng_inproc.7.html index aefe9260..f418548e 100644 --- a/man/tip/nng_inproc.7.html +++ b/man/tip/nng_inproc.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_inproc(7) --- <h1>nng_inproc(7)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/inproc/inproc.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/inproc/inproc.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_inproc_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_inproc_register.3.html b/man/tip/nng_inproc_register.3.html index 3e03f14c..8fc75327 100644 --- a/man/tip/nng_inproc_register.3.html +++ b/man/tip/nng_inproc_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_inproc_register(3) --- <h1>nng_inproc_register(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/inproc/inproc.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/inproc/inproc.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_inproc_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -30,6 +31,19 @@ layout: manpage_v2 <p>The <code>nng_inproc_register()</code> function registers the <em>inproc</em> transport(transport, <em>inproc</em>) for use.</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 deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +</td> +</tr> +</table> +</div> </div> </div> <div class="sect1"> diff --git a/man/tip/nng_iov.5.html b/man/tip/nng_iov.5.html index 9f69d02b..fac3ab6d 100644 --- a/man/tip/nng_iov.5.html +++ b/man/tip/nng_iov.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_iov(5) --- <h1>nng_iov(5)</h1> <div class="sect1"> @@ -16,11 +17,11 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-p">{</span> <span class="tok-kt">void</span> <span class="tok-o">*</span> <span class="tok-n">iov_buf</span><span class="tok-p">;</span> - <span class="tok-n">size_t</span> <span class="tok-n">iov_len</span><span class="tok-p">;</span> + <span class="tok-kt">size_t</span> <span class="tok-n">iov_len</span><span class="tok-p">;</span> <span class="tok-p">}</span> <span class="tok-n">nng_iov</span><span class="tok-p">;</span></code></pre> </div> </div> @@ -50,7 +51,7 @@ an <a href="nng_aio.5.html"><code>nng_aio</code></a> structure using the <dt class="hdlist1"><code>iov_buf</code></dt> <dd> <p>This is a pointer to the first byte within the memory being - referenced by this scatter/gather element.</p> +referenced by this scatter/gather element.</p> </dd> <dt class="hdlist1"><code>iov_len</code></dt> <dd> diff --git a/man/tip/nng_ipc.7.html b/man/tip/nng_ipc.7.html index ed2c43cc..c872246c 100644 --- a/man/tip/nng_ipc.7.html +++ b/man/tip/nng_ipc.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ipc(7) --- <h1>nng_ipc(7)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/ipc/ipc.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/ipc/ipc.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_ipc_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -120,7 +121,7 @@ the Named Pipes and the <code>AF_UNIX</code> based transports.</p> On Linux, this transport also can support abstract sockets. Abstract sockets use a URI-encoded name after the scheme, which allows arbitrary values to be conveyed in the path, including embedded <code>NUL</code> bytes. -For example, the name <code>"a\0b"</code> would be represented as <code>abstract://a%00b</code>.</p> +For example, the name ”a\0b“ would be represented as <code>abstract://a%00b</code>.</p> </div> <div class="admonitionblock tip"> <table> diff --git a/man/tip/nng_ipc_options.5.html b/man/tip/nng_ipc_options.5.html index 85311c46..e7c91d49 100644 --- a/man/tip/nng_ipc_options.5.html +++ b/man/tip/nng_ipc_options.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ipc_options(5) --- <h1>nng_ipc_options(5)</h1> <div class="sect1"> @@ -16,14 +17,14 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-cp">#define NNG_OPT_IPC_PEER_GID "ipc:peer-gid" -</span><span class="tok-cp">#define NNG_OPT_IPC_PEER_PID "ipc:peer-pid" -</span><span class="tok-cp">#define NNG_OPT_IPC_PEER_UID "ipc:peer-uid" -</span><span class="tok-cp">#define NNG_OPT_IPC_PEER_ZONEID "ipc:peer-zoneid" -</span><span class="tok-cp">#define NNG_OPT_IPC_PERMISSIONS "ipc:permissions" -</span><span class="tok-cp">#define NNG_OPT_IPC_SECURITY_DESCRIPTOR "ipc:security-descriptor"</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-cp">#define NNG_OPT_IPC_PEER_GID "ipc:peer-gid"</span> +<span class="tok-cp">#define NNG_OPT_IPC_PEER_PID "ipc:peer-pid"</span> +<span class="tok-cp">#define NNG_OPT_IPC_PEER_UID "ipc:peer-uid"</span> +<span class="tok-cp">#define NNG_OPT_IPC_PEER_ZONEID "ipc:peer-zoneid"</span> +<span class="tok-cp">#define NNG_OPT_IPC_PERMISSIONS "ipc:permissions"</span> +<span class="tok-cp">#define NNG_OPT_IPC_SECURITY_DESCRIPTOR "ipc:security-descriptor"</span></code></pre> </div> </div> </div> @@ -65,7 +66,7 @@ as the implementations of IPC are quite different on Windows and POSIX systems. <h3 id="_ipc_options">IPC Options</h3> <div class="dlist"> <dl> -<dt class="hdlist1">[[NNG_OPT_IPC_PEER_GID]]<code>NNG_OPT_IPC_PEER_GID</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_IPC_PEER_GID"></a><code>NNG_OPT_IPC_PEER_GID</code></dt> <dd> <p>(<code>uint64_t</code>) This read-only option provides a connected peer’s primary @@ -74,7 +75,7 @@ This is the effective group id of the peer when either the underlying <code>listen()</code> or <code>connect()</code> calls were made, and is not forgeable. This option is generally only available on POSIX systems.</p> </dd> -<dt class="hdlist1">[[NNG_OPT_IPC_PEER_PID]]<code>NNG_OPT_IPC_PEER_PID</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_IPC_PEER_PID"></a><code>NNG_OPT_IPC_PEER_PID</code></dt> <dd> <p>(<code>uint64_t</code>) This read-only option provides the the process id @@ -97,7 +98,7 @@ of a well-behaved one using this method. </table> </div> </dd> -<dt class="hdlist1">[[NNG_OPT_IPC_PEER_UID]]<code>NNG_OPT_IPC_PEER_UID</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_IPC_PEER_UID"></a><code>NNG_OPT_IPC_PEER_UID</code></dt> <dd> <p>(<code>uint64_t</code>) This read-only option provides a connected peer’s user id. @@ -105,13 +106,13 @@ This is the effective user id of the peer when either the underlying <code>listen()</code> or <code>connect()</code> calls were made, and is not forgeable. This option is generally only available on POSIX systems.</p> </dd> -<dt class="hdlist1">[[NNG_OPT_IPC_PEER_ZONEID]]<code>NNG_OPT_IPC_PEER_ZONEID</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_IPC_PEER_ZONEID"></a><code>NNG_OPT_IPC_PEER_ZONEID</code></dt> <dd> <p>(<code>uint64_t</code>) This read-only option provides a connected peer’s the zone id. Zones (and this option) are only supported on Solaris and illumos systems.</p> </dd> -<dt class="hdlist1">[[NNG_OPT_IPC_PERMISSIONS]]<code>NNG_OPT_IPC_PERMISSIONS</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_IPC_PERMISSIONS"></a><code>NNG_OPT_IPC_PERMISSIONS</code></dt> <dd> <p>(<code>int</code>) This write-only option may be applied to a listener to configure the @@ -179,7 +180,7 @@ permission. </table> </div> </dd> -<dt class="hdlist1">[[NNG_OPT_IPC_SECURITY_DESCRIPTOR]]<code>NNG_OPT_IPC_SECURITY_DESCRIPTOR</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_IPC_SECURITY_DESCRIPTOR"></a><code>NNG_OPT_IPC_SECURITY_DESCRIPTOR</code></dt> <dd> <p>(<code>PSECURITY_DESCRIPTOR</code>) This write-only option may be used on listeners on Windows platforms to diff --git a/man/tip/nng_ipc_register.3.html b/man/tip/nng_ipc_register.3.html index a6fa689b..628f1a25 100644 --- a/man/tip/nng_ipc_register.3.html +++ b/man/tip/nng_ipc_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ipc_register(3) --- <h1>nng_ipc_register(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/ipc/ipc.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/ipc/ipc.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_ipc_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -30,6 +31,19 @@ layout: manpage_v2 <p>The <code>nng_ipc_register()</code> function registers the <em>ipc</em> transport(transport, <em>ipc</em>) for use.</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 deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +</td> +</tr> +</table> +</div> </div> </div> <div class="sect1"> diff --git a/man/tip/nng_listen.3.html b/man/tip/nng_listen.3.html index aa2f3ebd..f63d5157 100644 --- a/man/tip/nng_listen.3.html +++ b/man/tip/nng_listen.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listen(3) --- <h1>nng_listen(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_listen</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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> <span class="tok-n">nng_listener</span> <span class="tok-o">*</span><span class="tok-n">lp</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> </div> </div> @@ -35,7 +36,7 @@ the newly created listener is stored at the address indicated by <em>lp</em>.</p </div> <div class="paragraph"> <p>Listeners are used to accept connections initiated by remote dialers. -An incoming connection generally results in and +An incoming connection generally results in an <a href="nng_pipe.5.html"><code>nng_pipe</code></a> object being created and attached to the socket <em>s</em>. Unlike dialers, listeners generally can create many pipes, which may be open concurrently.</p> diff --git a/man/tip/nng_listener.5.html b/man/tip/nng_listener.5.html index afdb98a5..e8d51198 100644 --- a/man/tip/nng_listener.5.html +++ b/man/tip/nng_listener.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener(5) --- <h1>nng_listener(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_listener_s</span> <span class="tok-n">nng_listener</span><span class="tok-p">;</span></code></pre> </div> </div> diff --git a/man/tip/nng_listener_close.3.html b/man/tip/nng_listener_close.3.html index 9f897fdb..58aa2de5 100644 --- a/man/tip/nng_listener_close.3.html +++ b/man/tip/nng_listener_close.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_close(3) --- <h1>nng_listener_close(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_close</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_listener_create.3.html b/man/tip/nng_listener_create.3.html index 7353e963..7654aa16 100644 --- a/man/tip/nng_listener_create.3.html +++ b/man/tip/nng_listener_create.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_create(3) --- <h1>nng_listener_create(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_create</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-o">*</span><span class="tok-n">listenerp</span><span class="tok-p">,</span> <span class="tok-n">nng_socket</span> <span class="tok-n">s</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> diff --git a/man/tip/nng_listener_get.3.html b/man/tip/nng_listener_get.3.html index b060d64e..93a7ee4f 100644 --- a/man/tip/nng_listener_get.3.html +++ b/man/tip/nng_listener_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_get(3) --- <h1>nng_listener_get(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_get</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_get</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</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">valszp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_get_bool</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span> @@ -28,13 +29,13 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_get_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">ptr</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_get_addr</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">sap</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_get_string</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -49,8 +50,7 @@ The actual options that may be retrieved in this way vary, and many are documented in <a href="nng_options.5.html">nng_options(5)</a>.</p> </div> <div class="paragraph"> -<p>Additionally some transport-specific options and protocol-specific options -are documented with the transports and protocols themselves.</p> +<p>Additionally some transport-specific options are documented with the transports themselves.</p> </div> <div class="sect2"> <h3 id="_forms">Forms</h3> diff --git a/man/tip/nng_listener_getopt.3.html b/man/tip/nng_listener_getopt.3.html index 823a78f5..d0049b84 100644 --- a/man/tip/nng_listener_getopt.3.html +++ b/man/tip/nng_listener_getopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_getopt(3) --- <h1>nng_listener_getopt(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_getopt</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_getopt</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</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">valszp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_getopt_bool</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span> @@ -28,13 +29,13 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_getopt_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">ptr</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_getopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_getopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_getopt_sockaddr</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">sap</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_getopt_string</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_getopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_getopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -42,14 +43,15 @@ layout: manpage_v2 <div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> -<div class="admonitionblock note"> +<div class="admonitionblock important"> <table> <tr> <td class="icon"> -<i class="fa icon-note" title="Note"></i> +<i class="fa icon-important" title="Important"></i> </td> <td class="content"> These functions are deprecated. Please see <a href="nng_listener_get.3.html">nng_listener_get</a>. +They may not be present if the library was built with <code>NNG_ELIDE_DEPRECATED</code>. </td> </tr> </table> @@ -61,8 +63,8 @@ The actual options that may be retrieved in this way vary, and many are documented in <a href="nng_options.5.html">nng_options(5)</a>.</p> </div> <div class="paragraph"> -<p>Additionally some transport-specific options and protocol-specific options -are documented with the transports and protocols themselves.</p> +<p>Additionally some transport-specific options +are documented with the transports themselves.</p> </div> <div class="sect2"> <h3 id="_forms">Forms</h3> diff --git a/man/tip/nng_listener_id.3.html b/man/tip/nng_listener_id.3.html index c48e8ce6..23233dc9 100644 --- a/man/tip/nng_listener_id.3.html +++ b/man/tip/nng_listener_id.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_id(3) --- <h1>nng_listener_id(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_id</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_listener_set.3.html b/man/tip/nng_listener_set.3.html index 79f09af6..4e769a25 100644 --- a/man/tip/nng_listener_set.3.html +++ b/man/tip/nng_listener_set.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_set(3) --- <h1>nng_listener_set(3)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_set</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">valsz</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_set</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">valsz</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_set_bool</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">bval</span><span class="tok-p">);</span> @@ -29,11 +30,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_set_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">ptr</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_set_string</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</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">str</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -48,8 +49,7 @@ The actual options that may be configured in this way vary, and many are documented in <a href="nng_options.5.html">nng_options(5)</a>.</p> </div> <div class="paragraph"> -<p>Additionally some transport-specific options and protocol-specific options -are documented with the transports and protocols themselves.</p> +<p>Additionally some transport-specific options are documented with the transports themselves.</p> </div> <div class="admonitionblock note"> <table> diff --git a/man/tip/nng_listener_setopt.3.html b/man/tip/nng_listener_setopt.3.html index 19ef85b1..93cf96a7 100644 --- a/man/tip/nng_listener_setopt.3.html +++ b/man/tip/nng_listener_setopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_setopt(3) --- <h1>nng_listener_setopt(3)</h1> <div class="sect1"> @@ -16,11 +17,11 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_setopt</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">valsz</span><span class="tok-p">);</span> - + <span class="tok-kt">size_t</span> <span class="tok-n">valsz</span><span class="tok-p">);</span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_setopt_bool</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">bval</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_setopt_int</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">ival</span><span class="tok-p">);</span> @@ -29,11 +30,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_setopt_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">ptr</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_setopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_setopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_setopt_string</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</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">str</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_setopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_listener_setopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -41,14 +42,15 @@ layout: manpage_v2 <div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> -<div class="admonitionblock note"> +<div class="admonitionblock important"> <table> <tr> <td class="icon"> -<i class="fa icon-note" title="Note"></i> +<i class="fa icon-important" title="Important"></i> </td> <td class="content"> These functions are deprecated. Please see <a href="nng_listener_set.3.html">nng_listener_set</a>. +They may not be present if the library was built with <code>NNG_ELIDE_DEPRECATED</code>. </td> </tr> </table> @@ -60,8 +62,8 @@ The actual options that may be configured in this way vary, and many are documented in <a href="nng_options.5.html">nng_options(5)</a>.</p> </div> <div class="paragraph"> -<p>Additionally some transport-specific options and protocol-specific options -are documented with the transports and protocols themselves.</p> +<p>Additionally some transport-specific options +are documented with the transports themselves.</p> </div> <div class="admonitionblock note"> <table> diff --git a/man/tip/nng_listener_start.3.html b/man/tip/nng_listener_start.3.html index 6cfd2858..9bed3250 100644 --- a/man/tip/nng_listener_start.3.html +++ b/man/tip/nng_listener_start.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_start(3) --- <h1>nng_listener_start(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_listener_start</span><span class="tok-p">(</span><span class="tok-n">nng_listener</span> <span class="tok-n">l</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> </div> </div> diff --git a/man/tip/nng_msg.5.html b/man/tip/nng_msg.5.html index 2a85a1fc..21c645e7 100644 --- a/man/tip/nng_msg.5.html +++ b/man/tip/nng_msg.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg(5) --- <h1>nng_msg(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_msg</span> <span class="tok-n">nng_msg</span><span class="tok-p">;</span></code></pre> </div> </div> @@ -73,6 +74,8 @@ by making use of scratch areas at the beginning and end of the message.</p> <a href="nng_msg_header.3.html">nng_msg_header(3)</a>, <a href="nng_msg_header_len.3.html">nng_msg_header_len(3)</a>, <a href="nng_msg_len.3.html">nng_msg_len(3)</a>, +<a href="nng_msg_capacity.3.html">nng_msg_capacity(3)</a>, +<a href="nng_msg_reserve.3.html">nng_msg_reserve(3)</a>, <a href="nng_msg_realloc.3.html">nng_msg_realloc(3)</a>, <a href="nng_recvmsg.3.html">nng_recvmsg(3)</a>, <a href="nng_sendmsg.3.html">nng_sendmsg(3)</a>, diff --git a/man/tip/nng_msg_alloc.3.html b/man/tip/nng_msg_alloc.3.html index e9be7944..794b0789 100644 --- a/man/tip/nng_msg_alloc.3.html +++ b/man/tip/nng_msg_alloc.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_alloc(3) --- <h1>nng_msg_alloc(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">**</span><span class="tok-n">msgp</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">**</span><span class="tok-n">msgp</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> </div> </div> </div> @@ -69,6 +70,8 @@ They are used with receive and transmit functions.</p> <a href="nng_msg_header.3.html">nng_msg_header(3)</a>, <a href="nng_msg_header_len.3.html">nng_msg_header_len(3)</a>, <a href="nng_msg_len.3.html">nng_msg_len(3)</a>, +<a href="nng_msg_capacity.3.html">nng_msg_capacity(3)</a>, +<a href="nng_msg_reserve.3.html">nng_msg_reserve(3)</a>, <a href="nng_msg_realloc.3.html">nng_msg_realloc(3)</a>, <a href="nng_strerror.3.html">nng_strerror(3)</a>, <a href="nng_msg.5.html">nng_msg(5)</a>, diff --git a/man/tip/nng_msg_append.3.html b/man/tip/nng_msg_append.3.html index 4635a0dd..5f3c189c 100644 --- a/man/tip/nng_msg_append.3.html +++ b/man/tip/nng_msg_append.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_append(3) --- <h1>nng_msg_append(3)</h1> <div class="sect1"> @@ -16,12 +17,12 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_append</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_append_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint16_t</span> <span class="tok-n">val16</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_append_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint32_t</span> <span class="tok-n">val32</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_append_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_append</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_append_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint16_t</span> <span class="tok-n">val16</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_append_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint32_t</span> <span class="tok-n">val32</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_append_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_msg_body.3.html b/man/tip/nng_msg_body.3.html index 739f563f..c086378f 100644 --- a/man/tip/nng_msg_body.3.html +++ b/man/tip/nng_msg_body.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_body(3) --- <h1>nng_msg_body(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-nf">nng_msg_body</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -78,6 +79,8 @@ or <a href="nng_msg_insert.3.html"><code>nng_msg_insert()</code></a> variants. <a href="nng_msg_free.3.html">nng_msg_free(3)</a>, <a href="nng_msg_insert.3.html">nng_msg_insert(3)</a>, <a href="nng_msg_len.3.html">nng_msg_len(3)</a>, +<a href="nng_msg_capacity.3.html">nng_msg_capacity(3)</a>, +<a href="nng_msg_reserve.3.html">nng_msg_reserve(3)</a>, <a href="nng_msg_realloc.3.html">nng_msg_realloc(3)</a>, <a href="nng_msg_trim.3.html">nng_msg_trim(3)</a>, <a href="nng_msg.5.html">nng_msg(5)</a>, diff --git a/man/tip/nng_msg_capacity.3.html b/man/tip/nng_msg_capacity.3.html new file mode 100644 index 00000000..9246c64c --- /dev/null +++ b/man/tip/nng_msg_capacity.3.html @@ -0,0 +1,64 @@ +--- +version: tip +layout: manpage_v2 +title: nng_msg_capacity(3) +--- +<h1>nng_msg_capacity(3)</h1> +<div class="sect1"> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>nng_msg_capacity - return message body length</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"><nng/nng.h></span> + +<span class="tok-kt">size_t</span> <span class="tok-nf">nng_msg_capacity</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</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>nng_msg_capacity()</code> returns the storage allocated for the body of message <em>msg</em>. +The capacity includes the current contents of the message and free space after it. +The message body may grow to capacity without performing any further allocations.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_return_values">RETURN VALUES</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>Allocated capacity for message body.</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="nng_msg_reserve.3.html">nng_msg_reserve(3)</a>, +<a href="nng_msg_alloc.3.html">nng_msg_alloc(3)</a>, +<a href="nng_msg_body.3.html">nng_msg_body(3)</a>, +<a href="nng_msg.5.html">nng_msg(5)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> diff --git a/man/tip/nng_msg_chop.3.html b/man/tip/nng_msg_chop.3.html index daba7b3f..9c12d5da 100644 --- a/man/tip/nng_msg_chop.3.html +++ b/man/tip/nng_msg_chop.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_chop(3) --- <h1>nng_msg_chop(3)</h1> <div class="sect1"> @@ -16,12 +17,12 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_chop</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_chop_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint16_t</span> <span class="tok-o">*</span><span class="tok-n">val16</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_chop_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint32_t</span> <span class="tok-o">*</span><span class="tok-n">val32</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_chop_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_chop</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</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-nf">nng_msg_chop_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint16_t</span> <span class="tok-o">*</span><span class="tok-n">val16</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_chop_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint32_t</span> <span class="tok-o">*</span><span class="tok-n">val32</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_chop_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -74,6 +75,8 @@ after converting them from network-byte order (big-endian) to native byte order. <a href="nng_msg_free.3.html">nng_msg_free(3)</a>, <a href="nng_msg_insert.3.html">nng_msg_insert(3)</a>, <a href="nng_msg_len.3.html">nng_msg_len(3)</a>, +<a href="nng_msg_capacity.3.html">nng_msg_capacity(3)</a>, +<a href="nng_msg_reserve.3.html">nng_msg_reserve(3)</a>, <a href="nng_msg_realloc.3.html">nng_msg_realloc(3)</a>, <a href="nng_msg_trim.3.html">nng_msg_trim(3)</a>, <a href="nng_strerror.3.html">nng_strerror(3)</a>, diff --git a/man/tip/nng_msg_clear.3.html b/man/tip/nng_msg_clear.3.html index a2edd237..3b974bc8 100644 --- a/man/tip/nng_msg_clear.3.html +++ b/man/tip/nng_msg_clear.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_clear(3) --- <h1>nng_msg_clear(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_msg_clear</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_msg_dup.3.html b/man/tip/nng_msg_dup.3.html index a2264f49..31a4c997 100644 --- a/man/tip/nng_msg_dup.3.html +++ b/man/tip/nng_msg_dup.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_dup(3) --- <h1>nng_msg_dup(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_dup</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">**</span><span class="tok-n">dup</span><span class="tok-p">,</span> <span class="tok-n">nng_msg_t</span> <span class="tok-o">*</span><span class="tok-n">orig</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_dup</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">**</span><span class="tok-n">dup</span><span class="tok-p">,</span> <span class="tok-kt">nng_msg_t</span> <span class="tok-o">*</span><span class="tok-n">orig</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_msg_free.3.html b/man/tip/nng_msg_free.3.html index 211b33de..6b81bec6 100644 --- a/man/tip/nng_msg_free.3.html +++ b/man/tip/nng_msg_free.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_free(3) --- <h1>nng_msg_free(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_msg_free</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_msg_get_pipe.3.html b/man/tip/nng_msg_get_pipe.3.html index 532138a7..064a5723 100644 --- a/man/tip/nng_msg_get_pipe.3.html +++ b/man/tip/nng_msg_get_pipe.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_get_pipe(3) --- <h1>nng_msg_get_pipe(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-n">nng_pipe</span> <span class="tok-nf">nng_msg_get_pipe</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_msg_header.3.html b/man/tip/nng_msg_header.3.html index c561d672..60abf0e7 100644 --- a/man/tip/nng_msg_header.3.html +++ b/man/tip/nng_msg_header.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header(3) --- <h1>nng_msg_header(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-nf">nng_msg_header</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_msg_header_append.3.html b/man/tip/nng_msg_header_append.3.html index d2b45fda..0f8673c8 100644 --- a/man/tip/nng_msg_header_append.3.html +++ b/man/tip/nng_msg_header_append.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_append(3) --- <h1>nng_msg_header_append(3)</h1> <div class="sect1"> @@ -16,12 +17,12 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_append</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_append_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint16_t</span> <span class="tok-n">val16</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_append_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint32_t</span> <span class="tok-n">val32</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_append_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_append</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_append_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint16_t</span> <span class="tok-n">val16</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_append_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint32_t</span> <span class="tok-n">val32</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_append_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_msg_header_chop.3.html b/man/tip/nng_msg_header_chop.3.html index a88d8af4..f2a71511 100644 --- a/man/tip/nng_msg_header_chop.3.html +++ b/man/tip/nng_msg_header_chop.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_chop(3) --- <h1>nng_msg_header_chop(3)</h1> <div class="sect1"> @@ -16,12 +17,12 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_chop</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_chop_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint16_t</span> <span class="tok-o">*</span><span class="tok-n">val16</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_chop_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint32_t</span> <span class="tok-o">*</span><span class="tok-n">val32</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_chop_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_chop</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</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-nf">nng_msg_header_chop_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint16_t</span> <span class="tok-o">*</span><span class="tok-n">val16</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_chop_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint32_t</span> <span class="tok-o">*</span><span class="tok-n">val32</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_chop_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_msg_header_clear.3.html b/man/tip/nng_msg_header_clear.3.html index 33f524b5..9cea2ac5 100644 --- a/man/tip/nng_msg_header_clear.3.html +++ b/man/tip/nng_msg_header_clear.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_clear(3) --- <h1>nng_msg_header_clear(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_msg_header_clear</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_msg_header_insert.3.html b/man/tip/nng_msg_header_insert.3.html index fff2439e..5672d0e5 100644 --- a/man/tip/nng_msg_header_insert.3.html +++ b/man/tip/nng_msg_header_insert.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_insert(3) --- <h1>nng_msg_header_insert(3)</h1> <div class="sect1"> @@ -16,12 +17,12 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_insert</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_insert_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint16_t</span> <span class="tok-n">val16</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_insert_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint32_t</span> <span class="tok-n">val32</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_insert_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_insert</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_insert_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint16_t</span> <span class="tok-n">val16</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_insert_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint32_t</span> <span class="tok-n">val32</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_insert_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -75,6 +76,8 @@ network-byte order (big-endian).</p> <a href="nng_msg_header_len.3.html">nng_msg_header_len(3)</a>, <a href="nng_msg_header_trim.3.html">nng_msg_header_trim(3)</a>, <a href="nng_msg_free.3.html">nng_msg_free(3)</a>, +<a href="nng_msg_capacity.3.html">nng_msg_capacity(3)</a>, +<a href="nng_msg_reserve.3.html">nng_msg_reserve(3)</a>, <a href="nng_msg_realloc.3.html">nng_msg_realloc(3)</a>, <a href="nng_strerror.3.html">nng_strerror(3)</a>, <a href="nng.7.html">nng(7)</a></p> diff --git a/man/tip/nng_msg_header_len.3.html b/man/tip/nng_msg_header_len.3.html index b867995d..68333fc6 100644 --- a/man/tip/nng_msg_header_len.3.html +++ b/man/tip/nng_msg_header_len.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_len(3) --- <h1>nng_msg_header_len(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-n">size_t</span> <span class="tok-nf">nng_msg_header_len</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">size_t</span> <span class="tok-nf">nng_msg_header_len</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_msg_header_trim.3.html b/man/tip/nng_msg_header_trim.3.html index be1e7ae3..9db2a803 100644 --- a/man/tip/nng_msg_header_trim.3.html +++ b/man/tip/nng_msg_header_trim.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_trim(3) --- <h1>nng_msg_header_trim(3)</h1> <div class="sect1"> @@ -16,12 +17,12 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_trim</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_trim_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint16_t</span> <span class="tok-o">*</span><span class="tok-n">val16</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_trim_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint32_t</span> <span class="tok-o">*</span><span class="tok-n">val32</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_trim_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_trim</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</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-nf">nng_msg_header_trim_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint16_t</span> <span class="tok-o">*</span><span class="tok-n">val16</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_trim_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint32_t</span> <span class="tok-o">*</span><span class="tok-n">val32</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_header_trim_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_msg_insert.3.html b/man/tip/nng_msg_insert.3.html index d7014c6a..19ed4254 100644 --- a/man/tip/nng_msg_insert.3.html +++ b/man/tip/nng_msg_insert.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_insert(3) --- <h1>nng_msg_insert(3)</h1> <div class="sect1"> @@ -16,12 +17,12 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_insert</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_insert_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint16_t</span> <span class="tok-n">val16</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_insert_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint32_t</span> <span class="tok-n">val32</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_insert_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_insert</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_insert_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint16_t</span> <span class="tok-n">val16</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_insert_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint32_t</span> <span class="tok-n">val32</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_insert_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_msg_len.3.html b/man/tip/nng_msg_len.3.html index 6b421c9e..ced2da68 100644 --- a/man/tip/nng_msg_len.3.html +++ b/man/tip/nng_msg_len.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_len(3) --- <h1>nng_msg_len(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-n">size_t</span> <span class="tok-nf">nng_msg_len</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">size_t</span> <span class="tok-nf">nng_msg_len</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_msg_realloc.3.html b/man/tip/nng_msg_realloc.3.html index 127990d5..1eb7b85f 100644 --- a/man/tip/nng_msg_realloc.3.html +++ b/man/tip/nng_msg_realloc.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_realloc(3) --- <h1>nng_msg_realloc(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_realloc</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_realloc</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</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> </div> </div> </div> @@ -39,14 +40,12 @@ and will reuse the existing memory when possible.</p> <i class="fa icon-tip" title="Tip"></i> </td> <td class="content"> -One way to further reduce message allocations is to allocate a message -larger than needed, then use this function or -<a href="nng_msg_chop.3.html"><code>nng_msg_chop()</code></a> to reduce the message size -to that actually needed. -The extra space left -over will still be present in the message, so that when the message size -needs to grow due to this function or <a href="nng_msg_append.3.html"><code>nng_msg_append()</code></a> -no actual memory allocations need to take place. +<code>nng_msg_realloc</code> is suitable for creating space for direct writing of data. +When appending many small pieces of data to a message using <a href="nng_msg_append.3.html"><code>nng_msg_append()</code></a>, +allocations may be reduced by first using <a href="nng_msg_reserve.3.html"><code>nng_msg_reserve()</code></a> +to create sufficient space. +In any case, reallocating or appending to a message is guaranteed to succeed if the resulting +body length is less than <a href="nng_msg_capacity.3.html"><code>nng_msg_capacity()</code></a>. </td> </tr> </table> @@ -96,7 +95,8 @@ may have changed, particularly if the message size is increasing. <h2 id="_see_also">SEE ALSO</h2> <div class="sectionbody"> <div class="paragraph text-left"> -<p><a href="nng_msg_alloc.3.html">nng_msg_alloc(3)</a>, +<p><a href="nng_msg_reserve.3.html">nng_msg_reserve(3)</a>, +<a href="nng_msg_alloc.3.html">nng_msg_alloc(3)</a>, <a href="nng_msg_append.3.html">nng_msg_append(3)</a>, <a href="nng_msg_body.3.html">nng_msg_body(3)</a>, <a href="nng_msg_chop.3.html">nng_msg_chop(3)</a>, diff --git a/man/tip/nng_msg_reserve.3.html b/man/tip/nng_msg_reserve.3.html new file mode 100644 index 00000000..e6d9cc0a --- /dev/null +++ b/man/tip/nng_msg_reserve.3.html @@ -0,0 +1,109 @@ +--- +version: tip +layout: manpage_v2 +title: nng_msg_reserve(3) +--- +<h1>nng_msg_reserve(3)</h1> +<div class="sect1"> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>nng_msg_reserve - reserve storage for a message</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"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_reserve</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">capacity</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>nng_msg_reserve()</code> function ensures a message has allocated enough storage +to accommodate a body of the given length. +This message attempts to avoid extra allocations, +and will reuse the existing memory when possible.</p> +</div> +<div class="admonitionblock tip"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-tip" title="Tip"></i> +</td> +<td class="content"> +Using this message before <a href="nng_msg_append.3.html"><code>nng_msg_append()</code></a> +will prevent additional memory allocations until the message’s length exceeds +the alotted capacity. +</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"> +Pointers to message body and header content obtained prior to this +function must not be in use, as the underlying memory used for the message +may have changed, particularly if the message capacity is increasing. +</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 0 on success, and non-zero otherwise.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_errors">ERRORS</h2> +<div class="sectionbody"> +<div class="hdlist"> +<table> +<tr> +<td class="hdlist1"> +<code>NNG_ENOMEM</code> +</td> +<td class="hdlist2"> +<p>Insufficient free memory exists to reallocate a message.</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="nng_msg_capacity.3.html">nng_msg_capacity(3)</a>, +<a href="nng_msg_alloc.3.html">nng_msg_alloc(3)</a>, +<a href="nng_msg_append.3.html">nng_msg_append(3)</a>, +<a href="nng_msg_body.3.html">nng_msg_body(3)</a>, +<a href="nng_msg_chop.3.html">nng_msg_chop(3)</a>, +<a href="nng_msg_free.3.html">nng_msg_free(3)</a>, +<a href="nng_msg_insert.3.html">nng_msg_insert(3)</a>, +<a href="nng_msg_len.3.html">nng_msg_len(3)</a>, +<a href="nng_msg_trim.3.html">nng_msg_trim(3)</a>, +<a href="nng_strerror.3.html">nng_strerror(3)</a>, +<a href="nng_msg.5.html">nng_msg(5)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> diff --git a/man/tip/nng_msg_set_pipe.3.html b/man/tip/nng_msg_set_pipe.3.html index 500824d8..02532a00 100644 --- a/man/tip/nng_msg_set_pipe.3.html +++ b/man/tip/nng_msg_set_pipe.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_set_pipe(3) --- <h1>nng_msg_set_pipe(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_msg_set_pipe</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">nng_pipe</span> <span class="tok-n">p</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_msg_trim.3.html b/man/tip/nng_msg_trim.3.html index 734c6612..90de3483 100644 --- a/man/tip/nng_msg_trim.3.html +++ b/man/tip/nng_msg_trim.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_trim(3) --- <h1>nng_msg_trim(3)</h1> <div class="sect1"> @@ -16,12 +17,12 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_trim</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_trim_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint16_t</span> <span class="tok-o">*</span><span class="tok-n">val16</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_trim_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint32_t</span> <span class="tok-o">*</span><span class="tok-n">val32</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_trim_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_trim</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</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-nf">nng_msg_trim_u16</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint16_t</span> <span class="tok-o">*</span><span class="tok-n">val16</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_trim_u32</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint32_t</span> <span class="tok-o">*</span><span class="tok-n">val32</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_trim_u64</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">val64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_msleep.3supp.html b/man/tip/nng_msleep.3supp.html index 3f0841ac..4ed0ed30 100644 --- a/man/tip/nng_msleep.3supp.html +++ b/man/tip/nng_msleep.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msleep(3supp) --- <h1>nng_msleep(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_msleep</span><span class="tok-p">(</span><span class="tok-n">nng_duration</span> <span class="tok-n">msec</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_mtx_alloc.3supp.html b/man/tip/nng_mtx_alloc.3supp.html index b40af39b..96b94aef 100644 --- a/man/tip/nng_mtx_alloc.3supp.html +++ b/man/tip/nng_mtx_alloc.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_mtx_alloc(3supp) --- <h1>nng_mtx_alloc(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_mtx</span> <span class="tok-n">nng_mtx</span><span class="tok-p">;</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_mtx_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_mtx</span> <span class="tok-o">**</span><span class="tok-n">mtxp</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_mtx_free.3supp.html b/man/tip/nng_mtx_free.3supp.html index 5192b0f6..85132893 100644 --- a/man/tip/nng_mtx_free.3supp.html +++ b/man/tip/nng_mtx_free.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_mtx_free(3supp) --- <h1>nng_mtx_free(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_mtx_free</span><span class="tok-p">(</span><span class="tok-n">nng_mtx</span> <span class="tok-o">*</span><span class="tok-n">mtx</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_mtx_lock.3supp.html b/man/tip/nng_mtx_lock.3supp.html index c8a27327..8232582f 100644 --- a/man/tip/nng_mtx_lock.3supp.html +++ b/man/tip/nng_mtx_lock.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_mtx_lock(3supp) --- <h1>nng_mtx_lock(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_mtx_lock</span><span class="tok-p">(</span><span class="tok-n">nng_mtx</span> <span class="tok-o">*</span><span class="tok-n">mtx</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_mtx_unlock.3supp.html b/man/tip/nng_mtx_unlock.3supp.html index 9a691386..03ef6da6 100644 --- a/man/tip/nng_mtx_unlock.3supp.html +++ b/man/tip/nng_mtx_unlock.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_mtx_unlock(3supp) --- <h1>nng_mtx_unlock(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_mtx_unlock</span><span class="tok-p">(</span><span class="tok-n">nng_mtx</span> <span class="tok-o">*</span><span class="tok-n">mtx</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_options.5.html b/man/tip/nng_options.5.html index ec72f764..582f5519 100644 --- a/man/tip/nng_options.5.html +++ b/man/tip/nng_options.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_options(5) --- <h1>nng_options(5)</h1> <div class="sect1"> @@ -16,27 +17,27 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-cp">#define NNG_OPT_SOCKNAME "socket-name" -</span><span class="tok-cp">#define NNG_OPT_RAW "raw" -</span><span class="tok-cp">#define NNG_OPT_PROTO "protocol" -</span><span class="tok-cp">#define NNG_OPT_PROTONAME "protocol-name" -</span><span class="tok-cp">#define NNG_OPT_PEER "peer" -</span><span class="tok-cp">#define NNG_OPT_PEERNAME "peer-name" -</span><span class="tok-cp">#define NNG_OPT_RECVBUF "recv-buffer" -</span><span class="tok-cp">#define NNG_OPT_SENDBUF "send-buffer" -</span><span class="tok-cp">#define NNG_OPT_RECVFD "recv-fd" -</span><span class="tok-cp">#define NNG_OPT_SENDFD "send-fd" -</span><span class="tok-cp">#define NNG_OPT_RECVTIMEO "recv-timeout" -</span><span class="tok-cp">#define NNG_OPT_SENDTIMEO "send-timeout" -</span><span class="tok-cp">#define NNG_OPT_LOCADDR "local-address" -</span><span class="tok-cp">#define NNG_OPT_REMADDR "remote-address" -</span><span class="tok-cp">#define NNG_OPT_URL "url" -</span><span class="tok-cp">#define NNG_OPT_MAXTTL "ttl-max" -</span><span class="tok-cp">#define NNG_OPT_RECVMAXSZ "recv-size-max" -</span><span class="tok-cp">#define NNG_OPT_RECONNMINT "reconnect-time-min" -</span><span class="tok-cp">#define NNG_OPT_RECONNMAXT "reconnect-time-max"</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-cp">#define NNG_OPT_SOCKNAME "socket-name"</span> +<span class="tok-cp">#define NNG_OPT_RAW "raw"</span> +<span class="tok-cp">#define NNG_OPT_PROTO "protocol"</span> +<span class="tok-cp">#define NNG_OPT_PROTONAME "protocol-name"</span> +<span class="tok-cp">#define NNG_OPT_PEER "peer"</span> +<span class="tok-cp">#define NNG_OPT_PEERNAME "peer-name"</span> +<span class="tok-cp">#define NNG_OPT_RECVBUF "recv-buffer"</span> +<span class="tok-cp">#define NNG_OPT_SENDBUF "send-buffer"</span> +<span class="tok-cp">#define NNG_OPT_RECVFD "recv-fd"</span> +<span class="tok-cp">#define NNG_OPT_SENDFD "send-fd"</span> +<span class="tok-cp">#define NNG_OPT_RECVTIMEO "recv-timeout"</span> +<span class="tok-cp">#define NNG_OPT_SENDTIMEO "send-timeout"</span> +<span class="tok-cp">#define NNG_OPT_LOCADDR "local-address"</span> +<span class="tok-cp">#define NNG_OPT_REMADDR "remote-address"</span> +<span class="tok-cp">#define NNG_OPT_URL "url"</span> +<span class="tok-cp">#define NNG_OPT_MAXTTL "ttl-max"</span> +<span class="tok-cp">#define NNG_OPT_RECVMAXSZ "recv-size-max"</span> +<span class="tok-cp">#define NNG_OPT_RECONNMINT "reconnect-time-min"</span> +<span class="tok-cp">#define NNG_OPT_RECONNMAXT "reconnect-time-max"</span></code></pre> </div> </div> </div> @@ -112,7 +113,9 @@ choose a random ephemeral port instead.</p> <dl> <dt class="hdlist1"><code>NNG_OPT_RAW</code></dt> <dd> -<p>(<code>bool</code>) +<p> + +(<code>bool</code>) This read-only option indicates whether the socket is in raw mode. If <code>true</code>, the socket is in raw mode, and if <code>false</code> the socket is in normal mode.</p> @@ -131,7 +134,8 @@ See <a href="nng.7.html">Raw Mode</a> for more details.</p> <dl> <dt class="hdlist1"><code>NNG_OPT_RECONNMINT</code></dt> <dd> -<p>(<a href="nng_duration.5.html"><code>nng_duration</code></a>) +<p> +(<a href="nng_duration.5.html"><code>nng_duration</code></a>) This is the minimum amount of time (milliseconds) to wait before attempting to establish a connection after a previous attempt has failed. This can be set on a socket, but it can also be overridden on an individual @@ -145,6 +149,7 @@ The option is irrelevant for listeners.</p> <dt class="hdlist1"><code>NNG_OPT_RECONNMAXT</code></dt> <dd> <p>(<code>NNG_OPT_RECONNMAXT</code>) + (<a href="nng_duration.5.html"><code>nng_duration</code></a>) This is the maximum amount of time (milliseconds) to wait before attempting to establish a connection after @@ -165,7 +170,9 @@ The option is irrelevant for listeners.</p> <dl> <dt class="hdlist1"><code>NNG_OPT_RECVBUF</code></dt> <dd> -<p>(<code>int</code>) +<p> + +(<code>int</code>) This is the depth of the socket’s receive buffer as a number of messages. Messages received by a transport may be buffered until the application has accepted them for delivery. @@ -179,7 +186,10 @@ For example <a href="nng_req.7.html"><em>req</em></a> can only deal with a singl <dl> <dt class="hdlist1"><code>NNG_OPT_RECVFD</code></dt> <dd> -<p>(<code>int</code>) +<p> + + +(<code>int</code>) This read-only option is used to obtain an integer file descriptor suitable for use with <a href="http://pubs.opengroup.org/onlinepubs/7908799/xsh/poll.html"><code>poll()</code></a>, @@ -240,7 +250,8 @@ See <a href="nng_aio_alloc.3.html"><code>nng_aio_alloc()</code></a>. <dl> <dt class="hdlist1"><code>NNG_OPT_RECVMAXSZ</code></dt> <dd> -<p>(<code>size_t</code>) +<p> +(<code>size_t</code>) This is the maximum message size that the will be accepted from a remote peer. If a peer attempts to send a message larger than this, then the message will be discarded. @@ -263,6 +274,24 @@ value to prevent denial-of-service attacks. </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 option should be set before any listeners or dialers are added. +Ideally this option should be set on specific dialers or listeners; setting it +on the socket globally is deprecated behavior, and might not work in a future release, +or might only work for endpoints that have not yet been created. +(Maximum receive sizes might be negotiated during connection establishment for +future transports, which means that the option needs to be set before any connections +are established.) +</td> +</tr> +</table> +</div> <div class="admonitionblock note"> <table> <tr> @@ -282,7 +311,9 @@ Some transports may have further message size restrictions. <dl> <dt class="hdlist1"><code>NNG_OPT_RECVTIMEO</code></dt> <dd> -<p>(<a href="nng_duration.5.html"><code>nng_duration</code></a>) +<p> + +(<a href="nng_duration.5.html"><code>nng_duration</code></a>) This is the socket receive timeout in milliseconds. When no message is available for receiving at the socket for this period of time, receive operations will fail with a return value of <code>NNG_ETIMEDOUT</code>.</p> @@ -304,7 +335,9 @@ Not all transports support this option.</p> <dl> <dt class="hdlist1"><code>NNG_OPT_SENDBUF</code></dt> <dd> -<p>(<code>int</code>) +<p> + +(<code>int</code>) This is the depth of the socket send buffer as a number of messages. Messages sent by an application may be buffered by the socket until a transport is ready to accept them for delivery. @@ -316,9 +349,9 @@ This value must be an integer between 0 and 8192, inclusive.</p> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> -Not all protocols support buffering sent messages; -generally multicast protocols like <a href="nng_pub.7.html"><em>pub</em></a> will -simply discard messages when they cannot be delivered immediately. +Not all protocols support buffering sent messages. +For example, <a href="nng_req.7.html"><em>req</em></a> can only have a single request +outstanding at a time (per context). </td> </tr> </table> @@ -330,7 +363,10 @@ simply discard messages when they cannot be delivered immediately. <dl> <dt class="hdlist1"><code>NNG_OPT_SENDFD</code></dt> <dd> -<p>(<code>int</code>) +<p> + + +(<code>int</code>) This read-only option is used to obtain an integer file descriptor suitable for use with <a href="http://pubs.opengroup.org/onlinepubs/7908799/xsh/poll.html"><code>poll()</code></a>, @@ -393,7 +429,9 @@ See <a href="nng_aio_alloc.3.html"><code>nng_aio_alloc()</code></a>. <dl> <dt class="hdlist1"><code>NNG_OPT_SENDTIMEO</code></dt> <dd> -<p>(<a href="nng_duration.5.html"><code>nng_duration</code></a>) +<p> + +(<a href="nng_duration.5.html"><code>nng_duration</code></a>) This is the socket send timeout in milliseconds. When a message cannot be queued for delivery by the socket for this period of time (such as if send buffers are full), the operation will fail with a @@ -405,9 +443,10 @@ return value of <code>NNG_ETIMEDOUT</code>.</p> <dl> <dt class="hdlist1"><code>NNG_OPT_SOCKNAME</code></dt> <dd> -<p>(string) +<p> +(string) This the socket name. -By default this is a string corresponding to the value of the socket. +By default, this is a string corresponding to the value of the socket. The string must fit within 64-bytes, including the terminating <code>NUL</code> byte. The value is intended for application use, and is not used for anything @@ -460,7 +499,9 @@ this option. <dl> <dt class="hdlist1"><code>NNG_OPT_URL</code></dt> <dd> -<p>(string) +<p> + +(string) This read-only option is used to obtain the URL with which a listener or dialer was configured. Accordingly it can only be used with dialers, listeners, and pipes.</p> diff --git a/man/tip/nng_opts_parse.3supp.html b/man/tip/nng_opts_parse.3supp.html index bc715d53..97a934be 100644 --- a/man/tip/nng_opts_parse.3supp.html +++ b/man/tip/nng_opts_parse.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_opts_parse(3supp) --- <h1>nng_opts_parse(3supp)</h1> <div class="sect1"> @@ -16,15 +17,19 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/options.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/options.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_optspec</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">o_name</span><span class="tok-p">;</span> <span class="tok-c1">// Long style name (may be NULL for short only) -</span><span class="tok-c1"></span> <span class="tok-kt">int</span> <span class="tok-n">o_short</span><span class="tok-p">;</span> <span class="tok-c1">// Short option (no clustering!) -</span><span class="tok-c1"></span> <span class="tok-kt">int</span> <span class="tok-n">o_val</span><span class="tok-p">;</span> <span class="tok-c1">// Value stored on a good parse (>0) -</span><span class="tok-c1"></span> <span class="tok-kt">bool</span> <span class="tok-n">o_arg</span><span class="tok-p">;</span> <span class="tok-c1">// Option takes an argument if true -</span><span class="tok-c1"></span><span class="tok-p">}</span> <span class="tok-n">nng_optspec</span><span class="tok-p">;</span> +</span> + <span class="tok-kt">int</span> <span class="tok-n">o_short</span><span class="tok-p">;</span> <span class="tok-c1">// Short option (no clustering!) +</span> + <span class="tok-kt">int</span> <span class="tok-n">o_val</span><span class="tok-p">;</span> <span class="tok-c1">// Value stored on a good parse (>0) +</span> + <span class="tok-kt">bool</span> <span class="tok-n">o_arg</span><span class="tok-p">;</span> <span class="tok-c1">// Option takes an argument if true +</span> +<span class="tok-p">}</span> <span class="tok-n">nng_optspec</span><span class="tok-p">;</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_opts_parse</span><span class="tok-p">(</span><span class="tok-kt">int</span> <span class="tok-n">argc</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-k">const</span> <span class="tok-o">*</span><span class="tok-n">argv</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_optspec</span> <span class="tok-o">*</span><span class="tok-n">spec</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-o">*</span><span class="tok-n">val</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">arg</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-o">*</span><span class="tok-n">idx</span><span class="tok-p">);</span></code></pre> </div> @@ -47,7 +52,7 @@ starting at the index referenced by <em>idx</em>. (New invocations typically set the value pointed to by <em>idx</em> to 1.)</p> </div> <div class="paragraph"> -<p>Options are parsed as specified by <em>spec</em> (see <a href="#Option Specification">[Option Specification]</a>.) +<p>Options are parsed as specified by <em>spec</em> (see <a href="#_option_specification">Option Specification</a>.) The value of the parsed option will be stored at the address indicated by <em>val</em>, and the value of <em>idx</em> will be incremented to reflect the next option to parse.</p> @@ -86,26 +91,26 @@ This structure has the following members:</p> <dl> <dt class="hdlist1"><code>o_name</code></dt> <dd> -<p>The long style name for the option, such as "verbose". - This will be parsed on the command line when it is prefixed with two dashes. - It may be <code>NULL</code> if only a short option is to be supported.</p> +<p>The long style name for the option, such as "verbose". +This will be parsed on the command line when it is prefixed with two dashes. +It may be <code>NULL</code> if only a short option is to be supported.</p> </dd> <dt class="hdlist1"><code>o_short</code></dt> <dd> <p>This is a single letter (at present only ASCII letters are supported). - These options appear as just a single letter, and are prefixed with a single dash on the command line. - The use of a slash in lieu of the dash is <em>not</em> supported, in order to avoid confusion with path name arguments. - This value may be set to 0 if no short option is needed.</p> +These options appear as just a single letter, and are prefixed with a single dash on the command line. +The use of a slash in lieu of the dash is <em>not</em> supported, in order to avoid confusion with path name arguments. +This value may be set to 0 if no short option is needed.</p> </dd> <dt class="hdlist1"><code>o_val</code></dt> <dd> <p>This is a numeric value that is unique to this option. - This value is assigned by the application program, and must be non-zero - for a valid option. - If this is zero, then it indicates the end of the specifications, and the - rest of this structure is ignored. - The value will be returned to the caller in <em>val</em> by <code>nng_opts_parse()</code> when - this option is parsed from the command line.</p> +This value is assigned by the application program, and must be non-zero +for a valid option. +If this is zero, then it indicates the end of the specifications, and the +rest of this structure is ignored. +The value will be returned to the caller in <em>val</em> by <code>nng_opts_parse()</code> when +this option is parsed from the command line.</p> </dd> <dt class="hdlist1"><code>o_arg</code></dt> <dd> @@ -119,7 +124,7 @@ This structure has the following members:</p> <div class="paragraph"> <p>Long options are parsed from the <em>argv</em> array, and are indicated when the element being scanned starts with two dashes. -For example, the "verbose" option would be specified as <code>--verbose</code> on +For example, the "verbose" option would be specified as <code>--verbose</code> on the command line. If a long option takes an argument, it can either immediately follow the option as the next element in <em>argv</em>, or it can be appended to @@ -169,7 +174,8 @@ unambiguously (meaning it must not match any other option specification.)</p> <div class="content"> <pre class="pygments highlight"><code data-lang="c"> <span class="tok-k">enum</span> <span class="tok-p">{</span> <span class="tok-n">OPT_LOGFILE</span><span class="tok-p">,</span> <span class="tok-n">OPT_VERBOSE</span> <span class="tok-p">};</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">logfile</span><span class="tok-p">;</span> <span class="tok-c1">// options to be set -</span><span class="tok-c1"></span> <span class="tok-kt">bool</span> <span class="tok-n">verbose</span><span class="tok-p">;</span> +</span> + <span class="tok-kt">bool</span> <span class="tok-n">verbose</span><span class="tok-p">;</span> <span class="tok-k">static</span> <span class="tok-n">nng_optspec</span> <span class="tok-n">specs</span><span class="tok-p">[]</span> <span class="tok-o">=</span> <span class="tok-p">{</span> <span class="tok-p">{</span> @@ -184,13 +190,14 @@ unambiguously (meaning it must not match any other option specification.)</p> <span class="tok-p">.</span><span class="tok-n">o_arg</span> <span class="tok-o">=</span> <span class="tok-nb">false</span><span class="tok-p">,</span> <span class="tok-p">},</span> <span class="tok-p">{</span> <span class="tok-p">.</span><span class="tok-n">o_val</span> <span class="tok-o">=</span> <span class="tok-mi">0</span><span class="tok-p">;</span> <span class="tok-c1">// Terminate array -</span><span class="tok-c1"></span> <span class="tok-p">}</span> +</span> + <span class="tok-p">}</span> <span class="tok-p">};</span> <span class="tok-k">for</span> <span class="tok-p">(</span><span class="tok-kt">int</span> <span class="tok-n">idx</span> <span class="tok-o">=</span> <span class="tok-mi">1</span><span class="tok-p">;;)</span> <span class="tok-p">{</span> <span class="tok-kt">int</span> <span class="tok-n">rv</span><span class="tok-p">,</span> <span class="tok-n">opt</span><span class="tok-p">;</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">arg</span><span class="tok-p">;</span> - <span class="tok-n">rv</span> <span class="tok-o">=</span> <span class="tok-n">nng_opts_parse</span><span class="tok-p">(</span><span class="tok-n">argc</span><span class="tok-p">,</span> <span class="tok-n">argv</span><span class="tok-p">,</span> <span class="tok-n">specs</span><span class="tok-p">,</span> <span class="tok-o">&</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-o">&</span><span class="tok-n">arg</span><span class="tok-p">,</span> <span class="tok-o">&</span><span class="tok-n">idx</span><span class="tok-p">);</span> + <span class="tok-n">rv</span> <span class="tok-o">=</span> <span class="tok-nf">nng_opts_parse</span><span class="tok-p">(</span><span class="tok-n">argc</span><span class="tok-p">,</span> <span class="tok-n">argv</span><span class="tok-p">,</span> <span class="tok-n">specs</span><span class="tok-p">,</span> <span class="tok-o">&</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-o">&</span><span class="tok-n">arg</span><span class="tok-p">,</span> <span class="tok-o">&</span><span class="tok-n">idx</span><span class="tok-p">);</span> <span class="tok-k">if</span> <span class="tok-p">(</span><span class="tok-n">rv</span> <span class="tok-o">!=</span> <span class="tok-mi">0</span><span class="tok-p">)</span> <span class="tok-p">{</span> <span class="tok-k">break</span><span class="tok-p">;</span> <span class="tok-p">}</span> @@ -204,8 +211,8 @@ unambiguously (meaning it must not match any other option specification.)</p> <span class="tok-p">}</span> <span class="tok-p">}</span> <span class="tok-k">if</span> <span class="tok-p">(</span><span class="tok-n">rv</span> <span class="tok-o">!=</span> <span class="tok-o">-</span><span class="tok-mi">1</span><span class="tok-p">)</span> <span class="tok-p">{</span> - <span class="tok-n">printf</span><span class="tok-p">(</span><span class="tok-s">"Options error: %s</span><span class="tok-se">\n</span><span class="tok-s">"</span><span class="tok-p">,</span> <span class="tok-n">nng_strerror</span><span class="tok-p">(</span><span class="tok-n">rv</span><span class="tok-p">));</span> - <span class="tok-n">exit</span><span class="tok-p">(</span><span class="tok-mi">1</span><span class="tok-p">);</span> + <span class="tok-nf">printf</span><span class="tok-p">(</span><span class="tok-s">"Options error: %s</span><span class="tok-se">\n</span><span class="tok-s">"</span><span class="tok-p">,</span> <span class="tok-nf">nng_strerror</span><span class="tok-p">(</span><span class="tok-n">rv</span><span class="tok-p">));</span> + <span class="tok-nf">exit</span><span class="tok-p">(</span><span class="tok-mi">1</span><span class="tok-p">);</span> <span class="tok-p">}</span></code></pre> </div> </div> diff --git a/man/tip/nng_pair.7.html b/man/tip/nng_pair.7.html index 45ef7cd6..4b7303b4 100644 --- a/man/tip/nng_pair.7.html +++ b/man/tip/nng_pair.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pair(7) --- <h1>nng_pair(7)</h1> <div class="sect1"> @@ -174,15 +175,15 @@ to the sender.</p> </div> <div class="dlist"> <dl> -<dt class="hdlist1"><a href="nng_options.5.html"><code>NNG_OPT_MAXTTL</code></a></dt> +<dt class="hdlist1"><a href="nng_options.5.html">`NNG_OPT_MAXTTL`</a></dt> <dd> <p>(<code>int</code>, version 1 only). Maximum time-to-live.</p> </dd> <dt class="hdlist1"><code>NNG_OPT_PAIR1_POLY</code></dt> <dd> <p>(<code>bool</code>, version 1 only) This option is no longer supported. - Formerly it was used to configure <em>polyamorous</em> mode, but that mode - is now established by using the <code>nng_pair1_open_poly()</code> function.</p> +Formerly it was used to configure <em>polyamorous</em> mode, but that mode +is now established by using the <code>nng_pair1_open_poly()</code> function.</p> </dd> </dl> </div> @@ -194,7 +195,7 @@ to the sender.</p> </div> <div class="paragraph"> <p>Version 1 of the pair protocol uses a single 32-bit unsigned value. The -low-order (big-endian) byte of this value contains a "hop" count, and is +low-order (big-endian) byte of this value contains a "hop" count, and is used in conjunction with the <a href="nng_options.5.html"><code>NNG_OPT_MAXTTL</code></a> option to guard against device forwarding loops. diff --git a/man/tip/nng_pair_open.3.html b/man/tip/nng_pair_open.3.html index 4ef504c1..a6c4ef03 100644 --- a/man/tip/nng_pair_open.3.html +++ b/man/tip/nng_pair_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pair_open(3) --- <h1>nng_pair_open(3)</h1> <div class="sect1"> @@ -17,8 +18,8 @@ layout: manpage_v2 <div class="listingblock"> <div class="title">Version 0</div> <div class="content"> -<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pair0/pair.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pair0/pair.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_pair0_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_pair0_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre> @@ -27,8 +28,8 @@ layout: manpage_v2 <div class="listingblock"> <div class="title">Version 1</div> <div class="content"> -<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pair1/pair.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pair1/pair.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_pair1_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_pair1_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> diff --git a/man/tip/nng_pipe.5.html b/man/tip/nng_pipe.5.html index 8163045f..6d6befdc 100644 --- a/man/tip/nng_pipe.5.html +++ b/man/tip/nng_pipe.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe(5) --- <h1>nng_pipe(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_pipe_s</span> <span class="tok-n">nng_pipe</span><span class="tok-p">;</span></code></pre> </div> </div> @@ -29,7 +30,7 @@ layout: manpage_v2 <div class="paragraph"> <p>An <code>nng_pipe</code> is a handle to a pipe object, which can be thought of as a single connection. -(In most cases this is actually the case -- the pipe is an abstraction for a +(In most cases this is actually the case — the pipe is an abstraction for a single TCP or IPC connection.) Pipes are associated with either the listener or dialer that created them, and therefore are also automatically associated with a single socket.</p> diff --git a/man/tip/nng_pipe_close.3.html b/man/tip/nng_pipe_close.3.html index bafdf669..eedd6b4a 100644 --- a/man/tip/nng_pipe_close.3.html +++ b/man/tip/nng_pipe_close.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_close(3) --- <h1>nng_pipe_close(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_close</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_pipe_dialer.3.html b/man/tip/nng_pipe_dialer.3.html index 63d771cb..6eb12ce9 100644 --- a/man/tip/nng_pipe_dialer.3.html +++ b/man/tip/nng_pipe_dialer.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_dialer(3) --- <h1>nng_pipe_dialer(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-n">nng_dialer</span> <span class="tok-nf">nng_pipe_dialer</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_pipe_get.3.html b/man/tip/nng_pipe_get.3.html index cf35d096..061fc9b9 100644 --- a/man/tip/nng_pipe_get.3.html +++ b/man/tip/nng_pipe_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_get(3) --- <h1>nng_pipe_get(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_get</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_get</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</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">valszp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_get_bool</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span> @@ -32,9 +33,9 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_get_string</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_pipe_getopt.3.html b/man/tip/nng_pipe_getopt.3.html index a8e429ee..4c2167e8 100644 --- a/man/tip/nng_pipe_getopt.3.html +++ b/man/tip/nng_pipe_getopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_getopt(3) --- <h1>nng_pipe_getopt(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_getopt</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_getopt</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</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">valszp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_getopt_bool</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span> @@ -32,9 +33,9 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_getopt_string</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_getopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_getopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_getopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_getopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_pipe_id.3.html b/man/tip/nng_pipe_id.3.html index d97f9c78..ebf37b70 100644 --- a/man/tip/nng_pipe_id.3.html +++ b/man/tip/nng_pipe_id.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_id(3) --- <h1>nng_pipe_id(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_pipe_id</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_pipe_listener.3.html b/man/tip/nng_pipe_listener.3.html index c715b06b..6d1b77b9 100644 --- a/man/tip/nng_pipe_listener.3.html +++ b/man/tip/nng_pipe_listener.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_listener(3) --- <h1>nng_pipe_listener(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-n">nng_listener</span> <span class="tok-nf">nng_pipe_listener</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_pipe_notify.3.html b/man/tip/nng_pipe_notify.3.html index 77ceedad..ad477be1 100644 --- a/man/tip/nng_pipe_notify.3.html +++ b/man/tip/nng_pipe_notify.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_notify(3) --- <h1>nng_pipe_notify(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">enum</span> <span class="tok-p">{</span> <span class="tok-n">NNG_PIPE_EV_ADD_PRE</span><span class="tok-p">,</span> <span class="tok-n">NNG_PIPE_EV_ADD_POST</span><span class="tok-p">,</span> diff --git a/man/tip/nng_pipe_socket.3.html b/man/tip/nng_pipe_socket.3.html index dd45cf4f..a98ccc5f 100644 --- a/man/tip/nng_pipe_socket.3.html +++ b/man/tip/nng_pipe_socket.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_socket(3) --- <h1>nng_pipe_socket(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-n">nng_socket</span> <span class="tok-nf">nng_pipe_socket</span><span class="tok-p">(</span><span class="tok-n">nng_pipe</span> <span class="tok-n">p</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_pub.7.html b/man/tip/nng_pub.7.html index c435be2c..55c02373 100644 --- a/man/tip/nng_pub.7.html +++ b/man/tip/nng_pub.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pub(7) --- <h1>nng_pub(7)</h1> <div class="sect1"> diff --git a/man/tip/nng_pub_open.3.html b/man/tip/nng_pub_open.3.html index 930609d9..08afb8e6 100644 --- a/man/tip/nng_pub_open.3.html +++ b/man/tip/nng_pub_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pub_open(3) --- <h1>nng_pub_open(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pubsub0/pub.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pubsub0/pub.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_pub0_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_pub0_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_pull.7.html b/man/tip/nng_pull.7.html index 425f1ca1..78dd4e8d 100644 --- a/man/tip/nng_pull.7.html +++ b/man/tip/nng_pull.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pull(7) --- <h1>nng_pull(7)</h1> <div class="sect1"> diff --git a/man/tip/nng_pull_open.3.html b/man/tip/nng_pull_open.3.html index aef13363..3e1545b4 100644 --- a/man/tip/nng_pull_open.3.html +++ b/man/tip/nng_pull_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pull_open(3) --- <h1>nng_pull_open(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pipeline0/pull.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pipeline0/pull.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_pull0_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_pull0_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_push.7.html b/man/tip/nng_push.7.html index 9e0ef507..600d65b7 100644 --- a/man/tip/nng_push.7.html +++ b/man/tip/nng_push.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_push(7) --- <h1>nng_push(7)</h1> <div class="sect1"> @@ -75,8 +76,30 @@ applications that need reliable delivery are encouraged to consider the </div> <div class="sect2"> <h3 id="_protocol_options">Protocol Options</h3> -<div class="paragraph"> -<p>The <em>push</em> protocol has no protocol-specific options.</p> +<div class="dlist"> +<dl> +<dt class="hdlist1"><a href="nng_options.5.html">`NNG_OPT_SENDBUF`</a></dt> +<dd> +<p>(<code>int</code>, 0 - 8192) +Normally this is set to zero, indicating that send operations are unbuffered. +In unbuffered operation, send operations will wait until a suitable peer is available to receive the message. +If this is set to a positive value (up to 8192), then an intermediate buffer is +provided for the socket with the specified depth (in messages).</p> +</dd> +</dl> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +Transport layer buffering may occur in addition to any socket + buffer determined by this option. +</td> +</tr> +</table> </div> </div> <div class="sect2"> diff --git a/man/tip/nng_push_open.3.html b/man/tip/nng_push_open.3.html index 8401d2a4..05a76c5d 100644 --- a/man/tip/nng_push_open.3.html +++ b/man/tip/nng_push_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_push_open(3) --- <h1>nng_push_open(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pipeline0/push.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pipeline0/push.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_push0_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_push0_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_random.3supp.html b/man/tip/nng_random.3supp.html index f8063039..35becdec 100644 --- a/man/tip/nng_random.3supp.html +++ b/man/tip/nng_random.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_random(3supp) --- <h1>nng_random(3supp)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-n">uint32_t</span> <span class="tok-nf">nng_random</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + +<span class="tok-kt">uint32_t</span> <span class="tok-nf">nng_random</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_recv.3.html b/man/tip/nng_recv.3.html index d9db3a37..e9e79abf 100644 --- a/man/tip/nng_recv.3.html +++ b/man/tip/nng_recv.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_recv(3) --- <h1>nng_recv(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_recv</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">sizep</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> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_recv</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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-o">*</span><span class="tok-n">sizep</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> </div> </div> </div> @@ -37,22 +38,22 @@ layout: manpage_v2 <dt class="hdlist1"><code>NNG_FLAG_NONBLOCK</code></dt> <dd> <p>The function returns immediately, even if no message is available. - Without this flag, the function will wait until a message is received - by the socket <em>s</em>, or any configured timer expires.</p> +Without this flag, the function will wait until a message is received +by the socket <em>s</em>, or any configured timer expires.</p> </dd> <dt class="hdlist1"><code>NNG_FLAG_ALLOC</code></dt> <dd> <p>If this flag is present, then a zero-copy mode is used. - In this case the caller must set the value of <em>data</em> to the location - of another pointer (of type <code>void *</code>), and the <em>sizep</em> pointer must be set - to a location to receive the size of the message body. - The function will then allocate a message buffer - (as if by <a href="nng_alloc.3.html"><code>nng_alloc()</code></a>), fill it with - the message body, and store it at the address referenced by <em>data</em>, and update - the size referenced by <em>sizep</em>. - The caller is responsible for disposing of the received buffer either by - the <a href="nng_free.3.html"><code>nng_free()</code></a> function or passing the message (also - with the <code>NNG_FLAG_ALLOC</code> flag) in a call to <a href="nng_send.3.html"><code>nng_send()</code></a>.</p> +In this case the caller must set the value of <em>data</em> to the location +of another pointer (of type <code>void *</code>), and the <em>sizep</em> pointer must be set +to a location to receive the size of the message body. +The function will then allocate a message buffer +(as if by <a href="nng_alloc.3.html"><code>nng_alloc()</code></a>), fill it with +the message body, and store it at the address referenced by <em>data</em>, and update +the size referenced by <em>sizep</em>. +The caller is responsible for disposing of the received buffer either by +the <a href="nng_free.3.html"><code>nng_free()</code></a> function or passing the message (also +with the <code>NNG_FLAG_ALLOC</code> flag) in a call to <a href="nng_send.3.html"><code>nng_send()</code></a>.</p> </dd> </dl> </div> diff --git a/man/tip/nng_recv_aio.3.html b/man/tip/nng_recv_aio.3.html index 9a186453..1343e3a6 100644 --- a/man/tip/nng_recv_aio.3.html +++ b/man/tip/nng_recv_aio.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_recv_aio(3) --- <h1>nng_recv_aio(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_recv_aio</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_recvmsg.3.html b/man/tip/nng_recvmsg.3.html index 766b67ba..60dd3a86 100644 --- a/man/tip/nng_recvmsg.3.html +++ b/man/tip/nng_recvmsg.3.html @@ -1,13 +1,14 @@ --- version: tip layout: manpage_v2 +title: nng_recvmsg(3) --- <h1>nng_recvmsg(3)</h1> <div class="sect1"> <h2 id="_name">NAME</h2> <div class="sectionbody"> <div class="paragraph"> -<p>nng_recvmsg - recv message</p> +<p>nng_recvmsg - receive a message</p> </div> </div> </div> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_recvmsg</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-n">nng_msg</span> <span class="tok-o">**</span><span class="tok-n">msgp</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> </div> </div> @@ -51,8 +52,8 @@ offer more functionality than the simpler <a href="nng_recv.3.html"><code>nng_re <dt class="hdlist1"><code>NNG_FLAG_NONBLOCK</code></dt> <dd> <p>The function returns immediately, even if no message is available. - Without this flag, the function will wait until a message is received - by the socket <em>s</em>, or any configured timer expires.</p> +Without this flag, the function will wait until a message is received +by the socket <em>s</em>, or any configured timer expires.</p> </dd> </dl> </div> @@ -157,6 +158,7 @@ Furthermore, some protocols may not support receiving data at all, such as <a href="nng_recv.3.html">nng_recv(3)</a>, <a href="nng_sendmsg.3.html">nng_sendmsg(3)</a>, <a href="nng_strerror.3.html">nng_strerror(3)</a>, +<a href="nng_socket.5.html">nng_socket(5)</a>, <a href="nng.7.html">nng(7)</a></p> </div> </div> diff --git a/man/tip/nng_rep.7.html b/man/tip/nng_rep.7.html index e828bb0c..c883e56f 100644 --- a/man/tip/nng_rep.7.html +++ b/man/tip/nng_rep.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_rep(7) --- <h1>nng_rep(7)</h1> <div class="sect1"> diff --git a/man/tip/nng_rep_open.3.html b/man/tip/nng_rep_open.3.html index 1bdebff4..4663f66f 100644 --- a/man/tip/nng_rep_open.3.html +++ b/man/tip/nng_rep_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_rep_open(3) --- <h1>nng_rep_open(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/reqrep0/rep.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/reqrep0/rep.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_rep0_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_rep0_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_req.7.html b/man/tip/nng_req.7.html index 1ed71b8c..32ca4dfe 100644 --- a/man/tip/nng_req.7.html +++ b/man/tip/nng_req.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_req(7) --- <h1>nng_req(7)</h1> <div class="sect1"> @@ -40,7 +41,7 @@ until a reply is received or the request times out.</p> </td> <td class="content"> This protocol is useful in setting up RPC-like services. -It is also "reliable", in that a the requester will keep retrying until +It is also "reliable", in that a the requester will keep retrying until a reply is received. </td> </tr> @@ -149,12 +150,12 @@ a separate socket.</p> <dt class="hdlist1"><code>NNG_OPT_REQ_RESENDTIME</code></dt> <dd> <p>(<a href="nng_duration.5.html"><code>nng_duration</code></a>) - When a new request is started, a timer of this duration is also started. - If no reply is received before this timer expires, then the request will - be resent. - (Requests are also automatically resent if the peer to whom - the original request was sent disconnects, or if a peer becomes available - while the requester is waiting for an available peer.)</p> +When a new request is started, a timer of this duration is also started. +If no reply is received before this timer expires, then the request will +be resent. +(Requests are also automatically resent if the peer to whom +the original request was sent disconnects, or if a peer becomes available +while the requester is waiting for an available peer.)</p> </dd> </dl> </div> diff --git a/man/tip/nng_req_open.3.html b/man/tip/nng_req_open.3.html index 4ffbf3f2..99c78d0d 100644 --- a/man/tip/nng_req_open.3.html +++ b/man/tip/nng_req_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_req_open(3) --- <h1>nng_req_open(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/reqrep0/req.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/reqrep0/req.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_req0_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_req0_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_respondent.7.html b/man/tip/nng_respondent.7.html index bf9d2d51..f17afcac 100644 --- a/man/tip/nng_respondent.7.html +++ b/man/tip/nng_respondent.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_respondent(7) --- <h1>nng_respondent(7)</h1> <div class="sect1"> diff --git a/man/tip/nng_respondent_open.3.html b/man/tip/nng_respondent_open.3.html index 73330241..734ae44f 100644 --- a/man/tip/nng_respondent_open.3.html +++ b/man/tip/nng_respondent_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_respondent_open(3) --- <h1>nng_respondent_open(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/survey0/respond.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/survey0/respond.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_respondent0_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_respondent0_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_send.3.html b/man/tip/nng_send.3.html index 4ccaa8e4..236109f8 100644 --- a/man/tip/nng_send.3.html +++ b/man/tip/nng_send.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_send(3) --- <h1>nng_send(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_send</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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-n">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> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_send</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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> </div> </div> </div> @@ -58,22 +59,22 @@ which are responses to requests, until they have first received a request.) <dt class="hdlist1"><code>NNG_FLAG_NONBLOCK</code></dt> <dd> <p>The function returns immediately, regardless of whether - the socket is able to accept the data or not. If the socket is unable - to accept the data (such as if backpressure exists because the peers - are consuming messages too slowly, or no peer is present), then the - function will return with <code>NNG_EAGAIN</code>. If this flag is not specified, - then the function will block if such a condition exists.</p> +the socket is able to accept the data or not. If the socket is unable +to accept the data (such as if backpressure exists because the peers +are consuming messages too slowly, or no peer is present), then the +function will return with <code>NNG_EAGAIN</code>. If this flag is not specified, +then the function will block if such a condition exists.</p> </dd> <dt class="hdlist1"><code>NNG_FLAG_ALLOC</code></dt> <dd> <p>The <em>data</em> was allocated using <a href="nng_alloc.3.html"><code>nng_alloc()</code></a>, or was - obtained from a call to <a href="nng_recv.3.html"><code>nng_recv()</code></a> with - the <code>NNG_FLAG_ALLOC</code> flag. - If this function returns success, then the <em>data</em> is "owned" by the - function, and it will assume responsibility for calling - <a href="nng_free.3.html"><code>nng_free()</code></a> when it is no longer needed. - In the absence of this flag, the <em>data</em> is copied by the implementation - before the function returns to the caller.</p> +obtained from a call to <a href="nng_recv.3.html"><code>nng_recv()</code></a> with +the <code>NNG_FLAG_ALLOC</code> flag. +If this function returns success, then the <em>data</em> is "owned" by the +function, and it will assume responsibility for calling +<a href="nng_free.3.html"><code>nng_free()</code></a> when it is no longer needed. +In the absence of this flag, the <em>data</em> is copied by the implementation +before the function returns to the caller.</p> </dd> </dl> </div> diff --git a/man/tip/nng_send_aio.3.html b/man/tip/nng_send_aio.3.html index ba0a2dbf..ce6d35f8 100644 --- a/man/tip/nng_send_aio.3.html +++ b/man/tip/nng_send_aio.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_send_aio(3) --- <h1>nng_send_aio(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_send_aio</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_sendmsg.3.html b/man/tip/nng_sendmsg.3.html index 7203fbc3..35c389d4 100644 --- a/man/tip/nng_sendmsg.3.html +++ b/man/tip/nng_sendmsg.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sendmsg(3) --- <h1>nng_sendmsg(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_sendmsg</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-n">nng_msg</span> <span class="tok-o">*</span><span class="tok-n">msg</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> </div> </div> @@ -81,12 +82,12 @@ are responses to requests, until they have first received a request.) <dt class="hdlist1"><code>NNG_FLAG_NONBLOCK</code></dt> <dd> <p>The function returns immediately, regardless of whether - the socket is able to accept the data or not. - If the socket is unable to accept the data (such as if backpressure exists - because the peers are consuming messages too slowly, or no peer is present), - then the function will return with <code>NNG_EAGAIN</code>. - If this flag is not specified, then the function will block if such a - condition exists.</p> +the socket is able to accept the data or not. +If the socket is unable to accept the data (such as if backpressure exists +because the peers are consuming messages too slowly, or no peer is present), +then the function will return with <code>NNG_EAGAIN</code>. +If this flag is not specified, then the function will block if such a +condition exists.</p> </dd> </dl> </div> diff --git a/man/tip/nng_setopt.3.html b/man/tip/nng_setopt.3.html index eef87b2b..cf1aa725 100644 --- a/man/tip/nng_setopt.3.html +++ b/man/tip/nng_setopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_setopt(3) --- <h1>nng_setopt(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_setopt</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">valsz</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_setopt</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">valsz</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_setopt_bool</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">bval</span><span class="tok-p">);</span> @@ -28,11 +29,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_setopt_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">ptr</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_setopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_setopt_size</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_setopt_string</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</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">str</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_setopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_setopt_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -40,14 +41,15 @@ layout: manpage_v2 <div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> -<div class="admonitionblock note"> +<div class="admonitionblock important"> <table> <tr> <td class="icon"> -<i class="fa icon-note" title="Note"></i> +<i class="fa icon-important" title="Important"></i> </td> <td class="content"> These functions are deprecated. Please see <a href="nng_socket_set.3.html">nng_socket_set</a>. +They may not be present if the library was built with <code>NNG_ELIDE_DEPRECATED</code>. </td> </tr> </table> diff --git a/man/tip/nng_sleep_aio.3.html b/man/tip/nng_sleep_aio.3.html index 03541073..c6920b97 100644 --- a/man/tip/nng_sleep_aio.3.html +++ b/man/tip/nng_sleep_aio.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sleep_aio(3) --- <h1>nng_sleep_aio(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_sleep_aio</span><span class="tok-p">(</span><span class="tok-n">nng_duration</span> <span class="tok-n">msec</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_sockaddr.5.html b/man/tip/nng_sockaddr.5.html index 467da3b4..e02f26b8 100644 --- a/man/tip/nng_sockaddr.5.html +++ b/man/tip/nng_sockaddr.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr(5) --- <h1>nng_sockaddr(5)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">union</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-p">{</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">s_family</span><span class="tok-p">;</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">s_family</span><span class="tok-p">;</span> <span class="tok-n">nng_sockaddr_ipc</span> <span class="tok-n">s_ipc</span><span class="tok-p">;</span> <span class="tok-n">nng_sockaddr_inproc</span> <span class="tok-n">s_inproc</span><span class="tok-p">;</span> <span class="tok-n">nng_sockaddr_in</span> <span class="tok-n">s_in</span><span class="tok-p">;</span> diff --git a/man/tip/nng_sockaddr_abstract.5.html b/man/tip/nng_sockaddr_abstract.5.html index 1eec3a30..70b59a68 100644 --- a/man/tip/nng_sockaddr_abstract.5.html +++ b/man/tip/nng_sockaddr_abstract.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr_abstract(5) --- <h1>nng_sockaddr_abstract(5)</h1> <div class="sect1"> @@ -16,15 +17,15 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">enum</span> <span class="tok-n">sockaddr_family</span> <span class="tok-p">{</span> <span class="tok-n">NNG_AF_ABSTRACT</span> <span class="tok-o">=</span> <span class="tok-mi">6</span><span class="tok-p">,</span> <span class="tok-p">};</span> <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-p">{</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">sa_len</span><span class="tok-p">;</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_len</span><span class="tok-p">;</span> <span class="tok-kt">char</span> <span class="tok-n">sa_name</span><span class="tok-p">[</span><span class="tok-mi">107</span><span class="tok-p">];</span> <span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_abstract</span><span class="tok-p">;</span></code></pre> </div> diff --git a/man/tip/nng_sockaddr_in.5.html b/man/tip/nng_sockaddr_in.5.html index 8e19a2ce..6013be31 100644 --- a/man/tip/nng_sockaddr_in.5.html +++ b/man/tip/nng_sockaddr_in.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr_in(5) --- <h1>nng_sockaddr_in(5)</h1> <div class="sect1"> @@ -16,16 +17,16 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">enum</span> <span class="tok-n">sockaddr_family</span> <span class="tok-p">{</span> <span class="tok-n">NNG_AF_INET</span> <span class="tok-o">=</span> <span class="tok-mi">3</span><span class="tok-p">,</span> <span class="tok-p">};</span> <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-p">{</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> - <span class="tok-n">uint32_t</span> <span class="tok-n">sa_addr</span><span class="tok-p">;</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> + <span class="tok-kt">uint32_t</span> <span class="tok-n">sa_addr</span><span class="tok-p">;</span> <span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_in</span><span class="tok-p">;</span></code></pre> </div> </div> @@ -56,12 +57,12 @@ for IPv6 addresses.</p> <dt class="hdlist1"><code>sa_port</code></dt> <dd> <p>This field holds the TCP or UDP port number, in network byte-order. - A zero value here is used when no specific port number is indicated.</p> +A zero value here is used when no specific port number is indicated.</p> </dd> <dt class="hdlist1"><code>sa_addr</code></dt> <dd> <p>This field holds the IP address in - network-byte order.</p> +network-byte order.</p> </dd> </dl> </div> diff --git a/man/tip/nng_sockaddr_in6.5.html b/man/tip/nng_sockaddr_in6.5.html index 6799d385..68de4f0d 100644 --- a/man/tip/nng_sockaddr_in6.5.html +++ b/man/tip/nng_sockaddr_in6.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr_in6(5) --- <h1>nng_sockaddr_in6(5)</h1> <div class="sect1"> @@ -16,17 +17,17 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">enum</span> <span class="tok-n">sockaddr_family</span> <span class="tok-p">{</span> <span class="tok-n">NNG_AF_INET6</span> <span class="tok-o">=</span> <span class="tok-mi">4</span><span class="tok-p">,</span> <span class="tok-p">};</span> <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-p">{</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> - <span class="tok-n">uint8_t</span> <span class="tok-n">sa_addr</span><span class="tok-p">[</span><span class="tok-mi">16</span><span class="tok-p">];</span> - <span class="tok-n">uint32_t</span> <span class="tok-n">sa_scope</span><span class="tok-p">;</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> + <span class="tok-kt">uint8_t</span> <span class="tok-n">sa_addr</span><span class="tok-p">[</span><span class="tok-mi">16</span><span class="tok-p">];</span> + <span class="tok-kt">uint32_t</span> <span class="tok-n">sa_scope</span><span class="tok-p">;</span> <span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_in6</span><span class="tok-p">;</span></code></pre> </div> </div> @@ -57,20 +58,20 @@ for IPv4 addresses.</p> <dt class="hdlist1"><code>sa_port</code></dt> <dd> <p>This field holds the TCP or UDP port number, in network byte-order. - A zero value here is used when no specific port number is indicated.</p> +A zero value here is used when no specific port number is indicated.</p> </dd> <dt class="hdlist1"><code>sa_addr</code></dt> <dd> <p>This field holds the IP address in - network-byte order.</p> +network-byte order.</p> </dd> <dt class="hdlist1"><code>sa_scope</code></dt> <dd> <p>This is the scope, and is typically used with link local - addresses to identify a specific interface. The details of - this are specific to the operating system. This value is - presented identically to the underlying system’s, including - any byte order considerations.</p> +addresses to identify a specific interface. The details of +this are specific to the operating system. This value is +presented identically to the underlying system’s, including +any byte order considerations.</p> </dd> </dl> </div> diff --git a/man/tip/nng_sockaddr_inproc.5.html b/man/tip/nng_sockaddr_inproc.5.html index 26fe3db2..4b8d0368 100644 --- a/man/tip/nng_sockaddr_inproc.5.html +++ b/man/tip/nng_sockaddr_inproc.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr_inproc(5) --- <h1>nng_sockaddr_inproc(5)</h1> <div class="sect1"> @@ -16,15 +17,15 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">enum</span> <span class="tok-n">sockaddr_family</span> <span class="tok-p">{</span> <span class="tok-n">NNG_AF_INPROC</span> <span class="tok-o">=</span> <span class="tok-mi">1</span><span class="tok-p">,</span> <span class="tok-p">};</span> <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-p">{</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">sa_name</span><span class="tok-p">[</span><span class="tok-mi">128</span><span class="tok-p">];</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_name</span><span class="tok-p">[</span><span class="tok-mi">128</span><span class="tok-p">];</span> <span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_inproc</span><span class="tok-p">;</span></code></pre> </div> </div> @@ -50,7 +51,7 @@ using the <a href="nng_inproc.7.html"><em>inproc</em></a> transport.</p> <dt class="hdlist1"><code>sa_name</code></dt> <dd> <p>This field holds an arbitrary C string, which is the name of the address. - The string must be <code>NUL</code> terminated, but no other restrictions exist.</p> +The string must be <code>NUL</code> terminated, but no other restrictions exist.</p> </dd> </dl> </div> diff --git a/man/tip/nng_sockaddr_ipc.5.html b/man/tip/nng_sockaddr_ipc.5.html index 90e9b04c..183ce16d 100644 --- a/man/tip/nng_sockaddr_ipc.5.html +++ b/man/tip/nng_sockaddr_ipc.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr_ipc(5) --- <h1>nng_sockaddr_ipc(5)</h1> <div class="sect1"> @@ -16,14 +17,14 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">enum</span> <span class="tok-n">sockaddr_family</span> <span class="tok-p">{</span> <span class="tok-n">NNG_AF_IPC</span> <span class="tok-o">=</span> <span class="tok-mi">2</span><span class="tok-p">,</span> <span class="tok-p">};</span> <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-p">{</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-kt">char</span> <span class="tok-n">sa_path</span><span class="tok-p">[</span><span class="tok-mi">128</span><span class="tok-p">];</span> <span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_ipc</span><span class="tok-p">;</span></code></pre> </div> diff --git a/man/tip/nng_sockaddr_zt.5.html b/man/tip/nng_sockaddr_zt.5.html index 3a5b6447..7d4d8017 100644 --- a/man/tip/nng_sockaddr_zt.5.html +++ b/man/tip/nng_sockaddr_zt.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr_zt(5) --- <h1>nng_sockaddr_zt(5)</h1> <div class="sect1"> @@ -16,17 +17,17 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">enum</span> <span class="tok-n">sockaddr_family</span> <span class="tok-p">{</span> <span class="tok-n">NNG_AF_ZT</span> <span class="tok-o">=</span> <span class="tok-mi">5</span><span class="tok-p">,</span> <span class="tok-p">};</span> <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-p">{</span> - <span class="tok-n">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> - <span class="tok-n">uint64_t</span> <span class="tok-n">sa_nwid</span><span class="tok-p">;</span> - <span class="tok-n">uint64_t</span> <span class="tok-n">sa_nodeid</span><span class="tok-p">;</span> - <span class="tok-n">uint32_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> + <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> + <span class="tok-kt">uint64_t</span> <span class="tok-n">sa_nwid</span><span class="tok-p">;</span> + <span class="tok-kt">uint64_t</span> <span class="tok-n">sa_nodeid</span><span class="tok-p">;</span> + <span class="tok-kt">uint32_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_zt</span><span class="tok-p">;</span></code></pre> </div> </div> @@ -65,27 +66,28 @@ are still considered experimental, and subject to change. </dd> <dt class="hdlist1"><code>sa_nwid</code></dt> <dd> -<p> This field holds the ZeroTier network number (or ID). - This value is in native byte order.</p> +<p> +This field holds the ZeroTier network number (or ID). +This value is in native byte order.</p> </dd> <dt class="hdlist1"><code>sa_nodeid</code></dt> <dd> <p>This field holds the ZeroTier node ID. - This value is in native byte order, and only the lower 40 bits - are significant. - (ZeroTier node numbers are 40 bits long.) - A zero value here is used for a wild-card to indicate that the - caller’s own node number be used.</p> +This value is in native byte order, and only the lower 40 bits +are significant. +(ZeroTier node numbers are 40 bits long.) +A zero value here is used for a wild-card to indicate that the +caller’s own node number be used.</p> </dd> <dt class="hdlist1"><code>sa_port</code></dt> <dd> <p>This field holds the port number used by the - <a href="nng_zerotier.7.html"><em>zt</em></a> transport to distinguish different - sockets. - This value in native byte order. - A zero value here indicates that a port number should be chosen - randomly from the ephemeral ports. - Only the lower 24 bits of the port number are used.</p> +<a href="nng_zerotier.7.html"><em>zt</em></a> transport to distinguish different +sockets. +This value in native byte order. +A zero value here indicates that a port number should be chosen +randomly from the ephemeral ports. +Only the lower 24 bits of the port number are used.</p> </dd> </dl> </div> diff --git a/man/tip/nng_socket.5.html b/man/tip/nng_socket.5.html index 81f421fd..9e5adb11 100644 --- a/man/tip/nng_socket.5.html +++ b/man/tip/nng_socket.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_socket(5) --- <h1>nng_socket(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_socket_s</span> <span class="tok-n">nng_socket</span><span class="tok-p">;</span></code></pre> </div> </div> diff --git a/man/tip/nng_socket_get.3.html b/man/tip/nng_socket_get.3.html index 8407e430..de493e9f 100644 --- a/man/tip/nng_socket_get.3.html +++ b/man/tip/nng_socket_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_socket_get(3) --- <h1>nng_socket_get(3)</h1> <div class="sect1"> @@ -16,17 +17,17 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</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">valszp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_bool</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_int</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-o">*</span><span class="tok-n">ivalp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_string</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span> @@ -49,8 +50,22 @@ The actual options that may be retrieved in this way vary. A number of them are documented in <a href="nng_options.5.html">nng_options(5)</a>.</p> </div> <div class="paragraph"> -<p>Additionally transport-specific options and protocol-specific options are -documented with the transports and protocols themselves.</p> +<p>Additionally protocol-specific options are documented with the protocols themselves.</p> +</div> +<div class="admonitionblock important"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-important" title="Important"></i> +</td> +<td class="content"> +Access to transport options via this function is deprecated, and may be +removed from a future release. Applications should instead make use of +<a href="nng_dialer_get.3.html">nng_dialer_get</a> or +<a href="nng_listener_get.3.html">nng_listener_get</a> for specific dialers or listeners. +</td> +</tr> +</table> </div> <div class="sect2"> <h3 id="_forms">Forms</h3> diff --git a/man/tip/nng_socket_id.3.html b/man/tip/nng_socket_id.3.html index ea5fc527..e95fe45b 100644 --- a/man/tip/nng_socket_id.3.html +++ b/man/tip/nng_socket_id.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_socket_id(3) --- <h1>nng_socket_id(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_socket_id</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_socket_set.3.html b/man/tip/nng_socket_set.3.html index ea96ccd5..e929be17 100644 --- a/man/tip/nng_socket_set.3.html +++ b/man/tip/nng_socket_set.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_socket_set(3) --- <h1>nng_socket_set(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_set</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">valsz</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_set</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">valsz</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_socket_set_bool</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">bval</span><span class="tok-p">);</span> @@ -28,11 +29,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_socket_set_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">ptr</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">z</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_socket_set_string</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</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">str</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">u64</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -48,14 +49,28 @@ specified by <em>opt</em>. A number of them are documented in <a href="nng_options.5.html">nng_options(5)</a>.</p> </div> <div class="paragraph"> -<p>Additionally some transport-specific and protocol-specific options are -documented with the transports and protocols themselves.</p> +<p>Protocol-specific options are documented with the protocol in question.</p> +</div> +<div class="admonitionblock important"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-important" title="Important"></i> +</td> +<td class="content"> +Access to transport options via this function is deprecated, and may be +removed from a future release. Applications should instead make use of +<a href="nng_dialer_set.3.html">nng_dialer_get</a> or +<a href="nng_listener_set.3.html">nng_listener_get</a> for specific dialers or listeners. +</td> +</tr> +</table> </div> <div class="sect2"> <h3 id="_forms">Forms</h3> <div class="paragraph"> <p>The details of the type, size, and semantics of the option will depend -on the actual option, and will be documented with the option itself.</p> +on the actual option, and is documented with the option itself.</p> </div> <div class="dlist"> <dl> diff --git a/man/tip/nng_stat.5.html b/man/tip/nng_stat.5.html index 072d9ff1..ccdf0e47 100644 --- a/man/tip/nng_stat.5.html +++ b/man/tip/nng_stat.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat(5) --- <h1>nng_stat(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span></code></pre> </div> </div> diff --git a/man/tip/nng_stat_bool.3.html b/man/tip/nng_stat_bool.3.html new file mode 100644 index 00000000..3f98b403 --- /dev/null +++ b/man/tip/nng_stat_bool.3.html @@ -0,0 +1,68 @@ +--- +version: tip +layout: manpage_v2 +title: nng_stat_bool(3) +--- +<h1>nng_stat_bool(3)</h1> +<div class="sect1"> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>nng_stat_bool - get statistic Boolean value</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"><nng/nng.h></span> + +<span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> + +<span class="tok-kt">bool</span> <span class="tok-nf">nng_stat_bool</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">stat</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>nng_stat_bool()</code> function returns the Boolean value for the statistic <em>stat</em>. +Otherwise, if the statistic is not of Boolean type, the result is indeterminate. +See <a href="nng_stat_type.3.html"><code>nng_stat_type()</code></a> for a description of statistic types.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_return_values">RETURN VALUES</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The boolean value associated with <em>stat</em>.</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="libnng.3.html">libnng(3)</a>, +<a href="nng_stats_get.3.html">nng_stats_get(3)</a>, +<a href="nng_stat_type.3.html">nng_stat_type(3)</a>, +<a href="nng_stat_unit.3.html">nng_stat_unit(3)</a>, +<a href="nng_stat_value.3.html">nng_stat_value(3)</a>, +<a href="nng_stat.5.html">nng_stat(5)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> diff --git a/man/tip/nng_stat_child.3.html b/man/tip/nng_stat_child.3.html index 08e02f6f..5f468872 100644 --- a/man/tip/nng_stat_child.3.html +++ b/man/tip/nng_stat_child.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_child(3) --- <h1>nng_stat_child(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> <span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-nf">nng_stat_child</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">parent</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_stat_desc.3.html b/man/tip/nng_stat_desc.3.html index 3afcb46d..577a86f2 100644 --- a/man/tip/nng_stat_desc.3.html +++ b/man/tip/nng_stat_desc.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_desc(3) --- <h1>nng_stat_desc(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</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-nf">nng_stat_desc</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">stat</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_stat_find.3.html b/man/tip/nng_stat_find.3.html index d54805a0..9892a449 100644 --- a/man/tip/nng_stat_find.3.html +++ b/man/tip/nng_stat_find.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_find(3) --- <h1>nng_stat_find(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> <span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-nf">nng_stat_find</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">stat</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">name</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_stat_find_dialer.3.html b/man/tip/nng_stat_find_dialer.3.html index c241a74e..ee8d8a82 100644 --- a/man/tip/nng_stat_find_dialer.3.html +++ b/man/tip/nng_stat_find_dialer.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_find_dialer(3) --- <h1>nng_stat_find_dialer(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_dialer</span> <span class="tok-n">nng_dialer</span><span class="tok-p">;</span> diff --git a/man/tip/nng_stat_find_listener.3.html b/man/tip/nng_stat_find_listener.3.html index 0244b278..8535c94d 100644 --- a/man/tip/nng_stat_find_listener.3.html +++ b/man/tip/nng_stat_find_listener.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_find_listener(3) --- <h1>nng_stat_find_listener(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_listener</span> <span class="tok-n">nng_listener</span><span class="tok-p">;</span> diff --git a/man/tip/nng_stat_find_socket.3.html b/man/tip/nng_stat_find_socket.3.html index 097f6f6e..f2dac780 100644 --- a/man/tip/nng_stat_find_socket.3.html +++ b/man/tip/nng_stat_find_socket.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_find_socket(3) --- <h1>nng_stat_find_socket(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_socket</span> <span class="tok-n">nng_socket</span><span class="tok-p">;</span> diff --git a/man/tip/nng_stat_name.3.html b/man/tip/nng_stat_name.3.html index 759189f4..d2dfb87d 100644 --- a/man/tip/nng_stat_name.3.html +++ b/man/tip/nng_stat_name.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_name(3) --- <h1>nng_stat_name(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</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-nf">nng_stat_name</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">stat</span><span class="tok-p">);</span></code></pre> @@ -38,7 +39,7 @@ layout: manpage_v2 <i class="fa icon-note" title="Note"></i> </td> <td class="content"> -The global root statistic will have the empty string ("") as it’s name. +The global root statistic will have the empty string ("") as it’s name. </td> </tr> </table> diff --git a/man/tip/nng_stat_next.3.html b/man/tip/nng_stat_next.3.html index cc959200..d9955be8 100644 --- a/man/tip/nng_stat_next.3.html +++ b/man/tip/nng_stat_next.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_next(3) --- <h1>nng_stat_next(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> <span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-nf">nng_stat_next</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">stat</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_stat_string.3.html b/man/tip/nng_stat_string.3.html index 106e9f81..29bbe2c7 100644 --- a/man/tip/nng_stat_string.3.html +++ b/man/tip/nng_stat_string.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_string(3) --- <h1>nng_stat_string(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</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-nf">nng_stat_string</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">stat</span><span class="tok-p">);</span></code></pre> @@ -35,6 +36,19 @@ which must be of type <code>NNG_STAT_STRING</code> (see <a href="nng_stat_type.3 <div class="paragraph"> <p>If the statistic is not of type <code>NNG_STAT_STRING</code>, then <code>NULL</code> will be returned.</p> </div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +The returned string is valid until <a href="nng_stats_free.3.html"><code>nng_stats_free()</code></a> is called to +free the memory for the snapshot. +</td> +</tr> +</table> +</div> </div> </div> <div class="sect1"> diff --git a/man/tip/nng_stat_timestamp.3.html b/man/tip/nng_stat_timestamp.3.html index 9a7e18a5..f1ce4dfb 100644 --- a/man/tip/nng_stat_timestamp.3.html +++ b/man/tip/nng_stat_timestamp.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_timestamp(3) --- <h1>nng_stat_timestamp(3)</h1> <div class="sect1"> @@ -16,11 +17,11 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> -<span class="tok-n">uint64_t</span> <span class="tok-nf">nng_stat_timestamp</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">stat</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">uint64_t</span> <span class="tok-nf">nng_stat_timestamp</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">stat</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_stat_type.3.html b/man/tip/nng_stat_type.3.html index e07f4332..e62e143d 100644 --- a/man/tip/nng_stat_type.3.html +++ b/man/tip/nng_stat_type.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_type(3) --- <h1>nng_stat_type(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> <span class="tok-k">enum</span> <span class="tok-p">{</span> diff --git a/man/tip/nng_stat_unit.3.html b/man/tip/nng_stat_unit.3.html index 6e070d94..294406f7 100644 --- a/man/tip/nng_stat_unit.3.html +++ b/man/tip/nng_stat_unit.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_unit(3) --- <h1>nng_stat_unit(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> <span class="tok-k">enum</span> <span class="tok-p">{</span> diff --git a/man/tip/nng_stat_value.3.html b/man/tip/nng_stat_value.3.html index 9fb81e59..594e6f78 100644 --- a/man/tip/nng_stat_value.3.html +++ b/man/tip/nng_stat_value.3.html @@ -1,13 +1,14 @@ --- version: tip layout: manpage_v2 +title: nng_stat_value(3) --- <h1>nng_stat_value(3)</h1> <div class="sect1"> <h2 id="_name">NAME</h2> <div class="sectionbody"> <div class="paragraph"> -<p>nng_stat_value - get statistic value</p> +<p>nng_stat_value - get statistic numeric value</p> </div> </div> </div> @@ -16,11 +17,11 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> -<span class="tok-n">uint64_t</span> <span class="tok-nf">nng_stat_value</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">stat</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">uint64_t</span> <span class="tok-nf">nng_stat_value</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">stat</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -30,9 +31,7 @@ layout: manpage_v2 <div class="sectionbody"> <div class="paragraph"> <p>The <code>nng_stat_value()</code> function returns a numeric value for the statistic <em>stat</em>. -If the statistic has a boolean value, then zero is returned for <code>false</code>, and -one is returned for <code>true</code>. -Otherwise, if the statistic is not of numeric type, then zero is returned. +If the statistic is not of numeric type, then zero is returned. See <a href="nng_stat_type.3.html"><code>nng_stat_type()</code></a> for a description of statistic types.</p> </div> </div> @@ -41,7 +40,7 @@ See <a href="nng_stat_type.3.html"><code>nng_stat_type()</code></a> for a descri <h2 id="_return_values">RETURN VALUES</h2> <div class="sectionbody"> <div class="paragraph"> -<p>The numeric or boolean value associated with <em>stat</em>.</p> +<p>The numeric value associated with <em>stat</em>.</p> </div> </div> </div> @@ -59,6 +58,7 @@ See <a href="nng_stat_type.3.html"><code>nng_stat_type()</code></a> for a descri <div class="paragraph text-left"> <p><a href="libnng.3.html">libnng(3)</a>, <a href="nng_stats_get.3.html">nng_stats_get(3)</a>, +<a href="nng_stat_bool.3.html">nng_stat_bool(3)</a>, <a href="nng_stat_type.3.html">nng_stat_type(3)</a>, <a href="nng_stat_unit.3.html">nng_stat_unit(3)</a>, <a href="nng_stat.5.html">nng_stat(5)</a>, diff --git a/man/tip/nng_stats_free.3.html b/man/tip/nng_stats_free.3.html index f26ef808..3c4e580b 100644 --- a/man/tip/nng_stats_free.3.html +++ b/man/tip/nng_stats_free.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stats_free(3) --- <h1>nng_stats_free(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> <span class="tok-kt">void</span> <span class="tok-nf">nng_stats_free</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_stats_get.3.html b/man/tip/nng_stats_get.3.html index 9bdb60a3..b1621f94 100644 --- a/man/tip/nng_stats_get.3.html +++ b/man/tip/nng_stats_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stats_get(3) --- <h1>nng_stats_get(3)</h1> <div class="sect1"> @@ -16,11 +17,11 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span> -<span class="tok-kt">int</span> <span class="tok-n">nng_stats_get</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">**</span><span class="tok-n">statsp</span><span class="tok-p">)</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stats_get</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">**</span><span class="tok-n">statsp</span><span class="tok-p">)</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_strdup.3.html b/man/tip/nng_strdup.3.html index 1d4068da..5b0b7949 100644 --- a/man/tip/nng_strdup.3.html +++ b/man/tip/nng_strdup.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_strdup(3) --- <h1>nng_strdup(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-nf">nng_strdup</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">src</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -31,7 +32,7 @@ layout: manpage_v2 </div> <div class="paragraph"> <p>This is logically equivalent to using <a href="nng_alloc.3.html"><code>nng_alloc()</code></a> -to allocate a region of memory of <code>strlen(s) + 1</code> bytes, and then +to allocate a region of memory of <code>strlen(s) + 1</code> bytes, and then using <code>strcpy()</code> to copy the string into the destination before returning it.</p> </div> diff --git a/man/tip/nng_stream.5.html b/man/tip/nng_stream.5.html index 649e72a4..f2dbab8d 100644 --- a/man/tip/nng_stream.5.html +++ b/man/tip/nng_stream.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream(5) --- <h1>nng_stream(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stream</span> <span class="tok-n">nng_stream</span><span class="tok-p">;</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_close.3str.html b/man/tip/nng_stream_close.3str.html index 3c367973..efede130 100644 --- a/man/tip/nng_stream_close.3str.html +++ b/man/tip/nng_stream_close.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_close(3str) --- <h1>nng_stream_close(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_stream_close</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_dialer.5.html b/man/tip/nng_stream_dialer.5.html index 2d3e0a84..285e2614 100644 --- a/man/tip/nng_stream_dialer.5.html +++ b/man/tip/nng_stream_dialer.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer(5) --- <h1>nng_stream_dialer(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stream_dialer</span> <span class="tok-n">nng_stream_dialer</span><span class="tok-p">;</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_dialer_alloc.3str.html b/man/tip/nng_stream_dialer_alloc.3str.html index 23f1746c..2c7f7db3 100644 --- a/man/tip/nng_stream_dialer_alloc.3str.html +++ b/man/tip/nng_stream_dialer_alloc.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_alloc(3str) --- <h1>nng_stream_dialer_alloc(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">**</span><span class="tok-n">dp</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">addr</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_alloc_url</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">**</span><span class="tok-n">dp</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_url</span> <span class="tok-o">*</span><span class="tok-n">url</span><span class="tok-p">);</span></code></pre> @@ -46,7 +47,7 @@ or pre-constructed </div> <div class="paragraph"> <p>These functions may support different URL schemes, such as -<code>ipc://</code>, <code>tcp://</code>, <code>tls+tcp://</code>, or <code>ws://</code>.</p> +<code>ipc://</code>, <code>tcp://</code>, <code>tls+tcp://</code>, or <code>ws://</code>.</p> </div> <div class="paragraph"> <p>Both forms store the dialer in the location referenced by <em>dp</em>.</p> diff --git a/man/tip/nng_stream_dialer_close.3str.html b/man/tip/nng_stream_dialer_close.3str.html index 29368827..00043079 100644 --- a/man/tip/nng_stream_dialer_close.3str.html +++ b/man/tip/nng_stream_dialer_close.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_close(3str) --- <h1>nng_stream_dialer_close(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_stream_dialer_close</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_dialer_dial.3str.html b/man/tip/nng_stream_dialer_dial.3str.html index 2e0123fc..ae12872b 100644 --- a/man/tip/nng_stream_dialer_dial.3str.html +++ b/man/tip/nng_stream_dialer_dial.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_dial(3str) --- <h1>nng_stream_dialer_dial(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_stream_dialer_dial</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_dialer_free.3str.html b/man/tip/nng_stream_dialer_free.3str.html index 46b3d917..247e133a 100644 --- a/man/tip/nng_stream_dialer_free.3str.html +++ b/man/tip/nng_stream_dialer_free.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_free(3str) --- <h1>nng_stream_dialer_free(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_stream_dialer_free</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_dialer_get.3str.html b/man/tip/nng_stream_dialer_get.3str.html index fb514120..a2fb1e8f 100644 --- a/man/tip/nng_stream_dialer_get.3str.html +++ b/man/tip/nng_stream_dialer_get.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_get(3str) --- <h1>nng_stream_dialer_get(3str)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_get</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">sizep</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_get</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</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">sizep</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_get_bool</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> @@ -28,13 +29,13 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_get_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">valp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_get_addr</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_get_string</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">valp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -190,7 +191,7 @@ numbers, and similar options.</p> </td> <td class="hdlist2"> <p>There was insufficient space to receive the object. - The amount of data actually needed is returned in <em>sizep</em>.</p> +The amount of data actually needed is returned in <em>sizep</em>.</p> </td> </tr> <tr> diff --git a/man/tip/nng_stream_dialer_set.3str.html b/man/tip/nng_stream_dialer_set.3str.html index 71ff3803..10e36dd9 100644 --- a/man/tip/nng_stream_dialer_set.3str.html +++ b/man/tip/nng_stream_dialer_set.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_set(3str) --- <h1>nng_stream_dialer_set(3str)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_set</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">name</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_set</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">name</span><span class="tok-p">,</span> <span class="tok-k">const</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-nf">nng_stream_dialer_set_bool</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">val</span><span class="tok-p">);</span> @@ -28,11 +29,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_set_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</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">int</span> <span class="tok-nf">nng_stream_dialer_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_set_string</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</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">val</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_set_addr</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">*</span><span class="tok-n">d</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">val</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_stream_free.3str.html b/man/tip/nng_stream_free.3str.html index 55dbdf42..b6b16ed8 100644 --- a/man/tip/nng_stream_free.3str.html +++ b/man/tip/nng_stream_free.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_free(3str) --- <h1>nng_stream_free(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_stream_free</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_get.3str.html b/man/tip/nng_stream_get.3str.html index fad04ccc..7105fb48 100644 --- a/man/tip/nng_stream_get.3str.html +++ b/man/tip/nng_stream_get.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_get(3str) --- <h1>nng_stream_get(3str)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_get</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">sizep</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_get</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</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">sizep</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_get_bool</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> @@ -28,13 +29,13 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_get_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">valp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_get_addr</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_get_string</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">valp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -190,7 +191,7 @@ numbers, and similar options.</p> </td> <td class="hdlist2"> <p>There was insufficient space to receive the object. - The amount of data actually needed is returned in <em>sizep</em>.</p> +The amount of data actually needed is returned in <em>sizep</em>.</p> </td> </tr> <tr> diff --git a/man/tip/nng_stream_listener.5.html b/man/tip/nng_stream_listener.5.html index afc49478..b80b6052 100644 --- a/man/tip/nng_stream_listener.5.html +++ b/man/tip/nng_stream_listener.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener(5) --- <h1>nng_stream_listener(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_stream_listener</span> <span class="tok-n">nng_stream_listener</span><span class="tok-p">;</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_listener_accept.3str.html b/man/tip/nng_stream_listener_accept.3str.html index a16cfc75..872028d4 100644 --- a/man/tip/nng_stream_listener_accept.3str.html +++ b/man/tip/nng_stream_listener_accept.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_accept(3str) --- <h1>nng_stream_listener_accept(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_stream_listener_accept</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_listener_alloc.3str.html b/man/tip/nng_stream_listener_alloc.3str.html index c7854d8a..06008696 100644 --- a/man/tip/nng_stream_listener_alloc.3str.html +++ b/man/tip/nng_stream_listener_alloc.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_alloc(3str) --- <h1>nng_stream_listener_alloc(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">**</span><span class="tok-n">lp</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">addr</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_alloc_url</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">**</span><span class="tok-n">lp</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_url</span> <span class="tok-o">*</span><span class="tok-n">url</span><span class="tok-p">);</span></code></pre> @@ -47,7 +48,7 @@ or pre-constructed </div> <div class="paragraph"> <p>These functions may support different URL schemes, such as -<code>ipc://</code>, <code>tcp://</code>, <code>tls+tcp://</code>, or <code>ws://</code>.</p> +<code>ipc://</code>, <code>tcp://</code>, <code>tls+tcp://</code>, or <code>ws://</code>.</p> </div> <div class="paragraph"> <p>Both forms store the listener in the location referenced by <em>lp</em>.</p> diff --git a/man/tip/nng_stream_listener_close.3str.html b/man/tip/nng_stream_listener_close.3str.html index ccd76c3e..2d2c4ce8 100644 --- a/man/tip/nng_stream_listener_close.3str.html +++ b/man/tip/nng_stream_listener_close.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_close(3str) --- <h1>nng_stream_listener_close(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_stream_listener_close</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_listener_free.3str.html b/man/tip/nng_stream_listener_free.3str.html index e1eabeea..bc08bd22 100644 --- a/man/tip/nng_stream_listener_free.3str.html +++ b/man/tip/nng_stream_listener_free.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_free(3str) --- <h1>nng_stream_listener_free(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_stream_listener_free</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-p">)</span><span class="tok-n">l</span><span class="tok-p">;</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_listener_get.3str.html b/man/tip/nng_stream_listener_get.3str.html index fc31284a..d7d42c41 100644 --- a/man/tip/nng_stream_listener_get.3str.html +++ b/man/tip/nng_stream_listener_get.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_get(3str) --- <h1>nng_stream_listener_get(3str)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_get</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</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-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">sizep</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_get</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</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">sizep</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_get_bool</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> @@ -28,13 +29,13 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_get_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">valp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_get_addr</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_get_string</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">valp</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span></code></pre> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">valp</span><span class="tok-p">);</span></code></pre> </div> </div> </div> @@ -191,7 +192,7 @@ numbers, and similar options.</p> </td> <td class="hdlist2"> <p>There was insufficient space to receive the object. - The amount of data actually needed is returned in <em>sizep</em>.</p> +The amount of data actually needed is returned in <em>sizep</em>.</p> </td> </tr> <tr> diff --git a/man/tip/nng_stream_listener_listen.3str.html b/man/tip/nng_stream_listener_listen.3str.html index b6a9bc28..33c60e78 100644 --- a/man/tip/nng_stream_listener_listen.3str.html +++ b/man/tip/nng_stream_listener_listen.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_listen(3str) --- <h1>nng_stream_listener_listen(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_listen</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_listener_set.3str.html b/man/tip/nng_stream_listener_set.3str.html index 72e33430..25366c46 100644 --- a/man/tip/nng_stream_listener_set.3str.html +++ b/man/tip/nng_stream_listener_set.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_set(3str) --- <h1>nng_stream_listener_set(3str)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_set</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">name</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_set</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">name</span><span class="tok-p">,</span> <span class="tok-k">const</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-nf">nng_stream_listener_set_bool</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">val</span><span class="tok-p">);</span> @@ -28,11 +29,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_set_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</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">int</span> <span class="tok-nf">nng_stream_listener_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_set_string</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</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">val</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_listener_set_addr</span><span class="tok-p">(</span><span class="tok-n">nng_stream_listener</span> <span class="tok-o">*</span><span class="tok-n">l</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">val</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_stream_recv.3str.html b/man/tip/nng_stream_recv.3str.html index 880d8816..3165ca91 100644 --- a/man/tip/nng_stream_recv.3str.html +++ b/man/tip/nng_stream_recv.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_recv(3str) --- <h1>nng_stream_recv(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_stream_recv</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_send.3str.html b/man/tip/nng_stream_send.3str.html index 77f34253..22672467 100644 --- a/man/tip/nng_stream_send.3str.html +++ b/man/tip/nng_stream_send.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_send(3str) --- <h1>nng_stream_send(3str)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_stream_send</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_stream_set.3str.html b/man/tip/nng_stream_set.3str.html index 7f1520c2..4428a3d3 100644 --- a/man/tip/nng_stream_set.3str.html +++ b/man/tip/nng_stream_set.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_set(3str) --- <h1>nng_stream_set(3str)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">name</span><span class="tok-p">,</span> <span class="tok-k">const</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-n">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">name</span><span class="tok-p">,</span> <span class="tok-k">const</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-nf">nng_stream_set_bool</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">val</span><span class="tok-p">);</span> @@ -28,11 +29,11 @@ layout: manpage_v2 <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</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">int</span> <span class="tok-nf">nng_stream_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">size_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_string</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</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">val</span><span class="tok-p">);</span> -<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-n">uint64_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> +<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">val</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_addr</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</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">opt</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">val</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_strerror.3.html b/man/tip/nng_strerror.3.html index 96bf8780..13081507 100644 --- a/man/tip/nng_strerror.3.html +++ b/man/tip/nng_strerror.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_strerror(3) --- <h1>nng_strerror(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span> <span class="tok-nf">nng_strerror</span><span class="tok-p">(</span><span class="tok-kt">int</span> <span class="tok-n">err</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_strfree.3.html b/man/tip/nng_strfree.3.html index b6c0a5df..ef0254af 100644 --- a/man/tip/nng_strfree.3.html +++ b/man/tip/nng_strfree.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_strfree(3) --- <h1>nng_strfree(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_strfree</span><span class="tok-p">(</span><span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">str</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -43,7 +44,7 @@ This should only be used with strings that were allocated by <a href="nng_strdup.3.html"><code>nng_strdup()</code></a> or <a href="nng_alloc.3.html"><code>nng_alloc()</code></a>. In all cases, the allocation size of the string must be the same -as <code>strlen(<em>str</em>) + 1</code>. +as <code>strlen(<em>str</em>) + 1</code>. </td> </tr> </table> diff --git a/man/tip/nng_sub.7.html b/man/tip/nng_sub.7.html index 400da1ec..27be33fe 100644 --- a/man/tip/nng_sub.7.html +++ b/man/tip/nng_sub.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sub(7) --- <h1>nng_sub(7)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pubsub0/sub.h></span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pubsub0/sub.h></span></code></pre> </div> </div> </div> @@ -81,11 +82,11 @@ Attempts to send messages will result in <code>NNG_ENOTSUP</code>.</p> <dt class="hdlist1"><code>NNG_OPT_SUB_SUBSCRIBE</code></dt> <dd> <p>This option registers a topic that the subscriber is interested in. - The option is write-only, and takes an array of bytes, of arbitrary size. - Each incoming message is checked against the list of subscribed topics. - If the body begins with the entire set of bytes in the topic, then the - message is accepted. If no topic matches, then the message is - discarded.</p> +The option is write-only, and takes an array of bytes, of arbitrary size. +Each incoming message is checked against the list of subscribed topics. +If the body begins with the entire set of bytes in the topic, then the +message is accepted. If no topic matches, then the message is +discarded.</p> <div class="admonitionblock note"> <table> <tr> @@ -119,15 +120,15 @@ To receive all messages, an empty topic (zero length) can be used. <dt class="hdlist1"><code>NNG_OPT_SUB_UNSUBSCRIBE</code></dt> <dd> <p>This option, also read-only, removes a topic from the subscription list. - Note that if the topic was not previously subscribed to with - <code>NNG_OPT_SUB_SUBSCRIBE</code> then an <code>NNG_ENOENT</code> error will result.</p> +Note that if the topic was not previously subscribed to with +<code>NNG_OPT_SUB_SUBSCRIBE</code> then an <code>NNG_ENOENT</code> error will result.</p> </dd> <dt class="hdlist1"><code>NNG_OPT_SUB_PREFNEW</code></dt> <dd> <p>(<code>bool</code>) - This read/write option specifies the behavior of the subscriber when the queue is full. - When <code>true</code> (the default), the subscriber will make room in the queue by removing the oldest message. - When <code>false</code>, the subscriber will reject messages if the message queue does not have room.</p> +This read/write option specifies the behavior of the subscriber when the queue is full. +When <code>true</code> (the default), the subscriber will make room in the queue by removing the oldest message. +When <code>false</code>, the subscriber will reject messages if the message queue does not have room.</p> </dd> </dl> </div> diff --git a/man/tip/nng_sub_open.3.html b/man/tip/nng_sub_open.3.html index 2f1a0640..55e2e51f 100644 --- a/man/tip/nng_sub_open.3.html +++ b/man/tip/nng_sub_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sub_open(3) --- <h1>nng_sub_open(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pubsub0/sub.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/pubsub0/sub.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_sub0_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_sub0_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_surveyor.7.html b/man/tip/nng_surveyor.7.html index 416f444c..c1c7b4c0 100644 --- a/man/tip/nng_surveyor.7.html +++ b/man/tip/nng_surveyor.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_surveyor(7) --- <h1>nng_surveyor(7)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/survey0/survey.h></span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/survey0/survey.h></span></code></pre> </div> </div> </div> @@ -134,12 +135,12 @@ version.)</p> <dt class="hdlist1"><code>NNG_OPT_SURVEYOR_SURVEYTIME</code></dt> <dd> <p>(<a href="nng_duration.5.html"><code>nng_duration</code></a>) Duration of surveys. - When a new survey is started, a timer of this duration is also started. - Any responses arriving this time will be discarded. - Attempts to receive - after the timer expires with no other surveys started will result in - <code>NNG_ESTATE</code>. - Attempts to receive when this timer expires will result in <code>NNG_ETIMEDOUT</code>.</p> +When a new survey is started, a timer of this duration is also started. +Any responses arriving this time will be discarded. +Attempts to receive +after the timer expires with no other surveys started will result in +<code>NNG_ESTATE</code>. +Attempts to receive when this timer expires will result in <code>NNG_ETIMEDOUT</code>.</p> </dd> </dl> </div> diff --git a/man/tip/nng_surveyor_open.3.html b/man/tip/nng_surveyor_open.3.html index 75c91398..c725d084 100644 --- a/man/tip/nng_surveyor_open.3.html +++ b/man/tip/nng_surveyor_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_surveyor_open(3) --- <h1>nng_surveyor_open(3)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/survey0/survey.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/protocol/survey0/survey.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_surveyor0_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_surveyor0_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_tcp.7.html b/man/tip/nng_tcp.7.html index a98355dd..3d85aa49 100644 --- a/man/tip/nng_tcp.7.html +++ b/man/tip/nng_tcp.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tcp(7) --- <h1>nng_tcp(7)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/tcp/tcp.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/tcp/tcp.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_tcp_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_tcp_options.5.html b/man/tip/nng_tcp_options.5.html index 49c41c1b..cb003761 100644 --- a/man/tip/nng_tcp_options.5.html +++ b/man/tip/nng_tcp_options.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tcp_options(5) --- <h1>nng_tcp_options(5)</h1> <div class="sect1"> @@ -16,11 +17,11 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-cp">#define NNG_OPT_TCP_NODELAY "tcp-nodelay" -</span><span class="tok-cp">#define NNG_OPT_TCP_KEEPALIVE "tcp-keepalive" -</span><span class="tok-cp">#define NNG_OPT_TCP_BOUND_PORT "tcp-bound-port"</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-cp">#define NNG_OPT_TCP_NODELAY "tcp-nodelay"</span> +<span class="tok-cp">#define NNG_OPT_TCP_KEEPALIVE "tcp-keepalive"</span> +<span class="tok-cp">#define NNG_OPT_TCP_BOUND_PORT "tcp-bound-port"</span></code></pre> </div> </div> </div> @@ -56,7 +57,7 @@ TCP/IP communications.</p> <dt class="hdlist1"><code>NNG_OPT_TCP_NODELAY</code></dt> <dd> <p>(<code>bool</code>) -This option is used to disable (or enable) the use of Nagle's algorithm +This option is used to disable (or enable) the use of Nagle's algorithm for TCP connections.</p> <div class="admonitionblock note"> <table> diff --git a/man/tip/nng_tcp_register.3.html b/man/tip/nng_tcp_register.3.html index cc0b0bc7..82602dfe 100644 --- a/man/tip/nng_tcp_register.3.html +++ b/man/tip/nng_tcp_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tcp_register(3) --- <h1>nng_tcp_register(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/tcp/tcp.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/tcp/tcp.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_tcp_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -30,6 +31,19 @@ layout: manpage_v2 <p>The <code>nng_tcp_register()</code> function registers the <em>tcp</em> transport(transport, <em>tcp</em>) for use.</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 deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +</td> +</tr> +</table> +</div> </div> </div> <div class="sect1"> diff --git a/man/tip/nng_thread_create.3supp.html b/man/tip/nng_thread_create.3supp.html index 0a385507..71f19032 100644 --- a/man/tip/nng_thread_create.3supp.html +++ b/man/tip/nng_thread_create.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_thread_create(3supp) --- <h1>nng_thread_create(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_thread</span> <span class="tok-n">nng_thread</span><span class="tok-p">;</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_thread_create</span><span class="tok-p">(</span><span class="tok-n">nng_thread</span> <span class="tok-o">**</span><span class="tok-n">thrp</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-p">(</span><span class="tok-o">*</span><span class="tok-n">func</span><span class="tok-p">)(</span><span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-p">),</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">arg</span><span class="tok-p">);</span></code></pre> diff --git a/man/tip/nng_thread_destroy.3supp.html b/man/tip/nng_thread_destroy.3supp.html index a9dc66a3..3958a7b0 100644 --- a/man/tip/nng_thread_destroy.3supp.html +++ b/man/tip/nng_thread_destroy.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_thread_destroy(3supp) --- <h1>nng_thread_destroy(3supp)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_thread_destroy</span><span class="tok-p">(</span><span class="tok-n">nng_thread</span> <span class="tok-o">*</span><span class="tok-kr">thread</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_thread_set_name.3supp.html b/man/tip/nng_thread_set_name.3supp.html index 2738d5d1..433ed8c0 100644 --- a/man/tip/nng_thread_set_name.3supp.html +++ b/man/tip/nng_thread_set_name.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_thread_set_name(3supp) --- <h1>nng_thread_set_name(3supp)</h1> <div class="sect1"> @@ -16,10 +17,10 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-kt">void</span> <span class="tok-nf">nng_set_thread_name</span><span class="tok-p">(</span><span class="tok-n">nng_thread</span> <span class="tok-o">*</span><span class="tok-kr">thread</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">name</span><span class="tok-p">);</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span> + +<span class="tok-kt">void</span> <span class="tok-nf">nng_thread_set_name</span><span class="tok-p">(</span><span class="tok-n">nng_thread</span> <span class="tok-o">*</span><span class="tok-kr">thread</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">name</span><span class="tok-p">);</span></code></pre> </div> </div> </div> diff --git a/man/tip/nng_tls.7.html b/man/tip/nng_tls.7.html index 27d02cbd..c9d51637 100644 --- a/man/tip/nng_tls.7.html +++ b/man/tip/nng_tls.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls(7) --- <h1>nng_tls(7)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/tls/tls.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_tls_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -88,17 +89,17 @@ license terms of any libraries you use. <div class="sect2"> <h3 id="_uri_format">URI Format</h3> <div class="paragraph"> -<p>(URI, <code>tls+tcp://</code>) -This transport uses URIs using the scheme <code>tls+tcp://</code>, followed by +<p>(URI, <code>tls+tcp://</code>) +This transport uses URIs using the scheme <code>tls+tcp://</code>, followed by an IP address or hostname, followed by a colon and finally a TCP port number. For example, to contact port 4433 on the localhost -either of the following URIs could be used: <code>tls+tcp://127.0.0.1:4433</code> or -<code>tls+tcp://localhost:4433</code>.</p> +either of the following URIs could be used: <code>tls+tcp://127.0.0.1:4433</code> or +<code>tls+tcp://localhost:4433</code>.</p> </div> <div class="paragraph"> -<p>A URI may be restricted to IPv6 using the scheme <code>tls+tcp6://</code>, and may -be restricted to IPv4 using the scheme <code>tls+tcp4://</code>.</p> +<p>A URI may be restricted to IPv6 using the scheme <code>tls+tcp6://</code>, and may +be restricted to IPv4 using the scheme <code>tls+tcp4://</code>.</p> </div> <div class="admonitionblock note"> <table> @@ -107,7 +108,7 @@ be restricted to IPv4 using the scheme <code>tls+tcp4://</code>.</p> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> -Specifying <code>tls+tcp6://</code> may not prevent IPv4 hosts from being used with +Specifying <code>tls+tcp6://</code> may not prevent IPv4 hosts from being used with IPv4-in-IPv6 addresses, particularly when using a wildcard hostname with listeners. The details of this varies across operating systems. @@ -122,7 +123,7 @@ The details of this varies across operating systems. <i class="fa icon-note" title="Note"></i> </td> <td class="content"> -Both <code>tls+tcp6://</code> and <code>tls+tcp4://</code> are specific to <em>NNG</em>, and may not +Both <code>tls+tcp6://</code> and <code>tls+tcp4://</code> are specific to <em>NNG</em>, and may not be understood by other implementations. </td> </tr> @@ -147,8 +148,8 @@ square brackets (<code>[]</code>) to avoid confusion with the final colon separating the port.</p> </div> <div class="paragraph"> -<p>For example, the same port 4433 on the IPv6 loopback address ('::1') would -be specified as <code>tls+tcp://[::1]:4433</code>.</p> +<p>For example, the same port 4433 on the IPv6 loopback address ('::1') would +be specified as <code>tls+tcp://[::1]:4433</code>.</p> </div> <div class="admonitionblock tip"> <table> @@ -176,13 +177,13 @@ and could be used to listen to port 9999 on the host:</p> <div class="olist arabic"> <ol class="arabic"> <li> -<p><code>tls+tcp://0.0.0.0:9999</code></p> +<p><code>tls+tcp://0.0.0.0:9999</code></p> </li> <li> -<p><code>tls+tcp://*:9999</code></p> +<p><code>tls+tcp://*:9999</code></p> </li> <li> -<p><code>tls+tcp://:9999</code></p> +<p><code>tls+tcp://:9999</code></p> </li> </ol> </div> @@ -235,6 +236,12 @@ Note that setting these must be done before the transport is started.</p> <p><a href="nng_tls_options.5.html"><code>NNG_OPT_TLS_VERIFIED_</code></a></p> </li> <li> +<p><a href="nng_tls_options.5.html"><code>NNG_OPT_TLS_PEER_CN</code></a></p> +</li> +<li> +<p><a href="nng_tls_options.5.html"><code>NNG_OPT_TLS_PEER_ALT_NAMES</code></a></p> +</li> +<li> <p><a href="nng_options.5.html"><code>NNG_OPT_URL</code></a></p> </li> </ul> diff --git a/man/tip/nng_tls_config.5.html b/man/tip/nng_tls_config.5.html index f9874ab0..7f41904b 100644 --- a/man/tip/nng_tls_config.5.html +++ b/man/tip/nng_tls_config.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config(5) --- <h1>nng_tls_config(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_tls_config</span> <span class="tok-n">nng_tls_config</span><span class="tok-p">;</span></code></pre> </div> </div> diff --git a/man/tip/nng_tls_config_alloc.3tls.html b/man/tip/nng_tls_config_alloc.3tls.html index 83eebe48..0ac859fd 100644 --- a/man/tip/nng_tls_config_alloc.3tls.html +++ b/man/tip/nng_tls_config_alloc.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_alloc(3tls) --- <h1>nng_tls_config_alloc(3tls)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">enum</span> <span class="tok-n">nng_tls_mode</span> <span class="tok-p">{</span> <span class="tok-n">NNG_TLS_MODE_CLIENT</span><span class="tok-p">,</span> <span class="tok-n">NNG_TLS_MODE_SERVER</span> diff --git a/man/tip/nng_tls_config_auth_mode.3tls.html b/man/tip/nng_tls_config_auth_mode.3tls.html index 76fdb85a..20172fda 100644 --- a/man/tip/nng_tls_config_auth_mode.3tls.html +++ b/man/tip/nng_tls_config_auth_mode.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_auth_mode(3tls) --- <h1>nng_tls_config_auth_mode(3tls)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">enum</span> <span class="tok-n">nng_tls_auth_mode</span> <span class="tok-p">{</span> <span class="tok-n">NNG_TLS_AUTH_MODE_NONE</span><span class="tok-p">,</span> <span class="tok-n">NNG_TLS_AUTH_MODE_OPTIONAL</span><span class="tok-p">,</span> diff --git a/man/tip/nng_tls_config_ca_chain.3tls.html b/man/tip/nng_tls_config_ca_chain.3tls.html index ddf0ee10..971095c0 100644 --- a/man/tip/nng_tls_config_ca_chain.3tls.html +++ b/man/tip/nng_tls_config_ca_chain.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_ca_chain(3tls) --- <h1>nng_tls_config_ca_chain(3tls)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_tls_config_ca_chain</span><span class="tok-p">(</span><span class="tok-n">nng_tls_config</span> <span class="tok-o">*</span><span class="tok-n">cfg</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">chain</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">crl</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_tls_config_ca_file.3tls.html b/man/tip/nng_tls_config_ca_file.3tls.html index c764d5ac..9ae0db00 100644 --- a/man/tip/nng_tls_config_ca_file.3tls.html +++ b/man/tip/nng_tls_config_ca_file.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_ca_file(3tls) --- <h1>nng_tls_config_ca_file(3tls)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_tls_config_ca_file</span><span class="tok-p">(</span><span class="tok-n">nng_tls_config</span> <span class="tok-o">*</span><span class="tok-n">cfg</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">path</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_tls_config_cert_key_file.3tls.html b/man/tip/nng_tls_config_cert_key_file.3tls.html index e12a54ae..9f20af64 100644 --- a/man/tip/nng_tls_config_cert_key_file.3tls.html +++ b/man/tip/nng_tls_config_cert_key_file.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_cert_key_file(3tls) --- <h1>nng_tls_config_cert_key_file(3tls)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_tls_config_cert_key_file</span><span class="tok-p">(</span><span class="tok-n">nng_tls_config</span> <span class="tok-o">*</span><span class="tok-n">cfg</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">path</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">pass</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_tls_config_free.3tls.html b/man/tip/nng_tls_config_free.3tls.html index f96a7b7f..7f738366 100644 --- a/man/tip/nng_tls_config_free.3tls.html +++ b/man/tip/nng_tls_config_free.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_free(3tls) --- <h1>nng_tls_config_free(3tls)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_tls_config_free</span><span class="tok-p">(</span><span class="tok-n">nng_tls_config</span> <span class="tok-o">*</span><span class="tok-n">cfg</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_tls_config_hold.3tls.html b/man/tip/nng_tls_config_hold.3tls.html index c6eee3ee..c9102e82 100644 --- a/man/tip/nng_tls_config_hold.3tls.html +++ b/man/tip/nng_tls_config_hold.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_hold(3tls) --- <h1>nng_tls_config_hold(3tls)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_tls_config_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_tls_config</span> <span class="tok-o">*</span><span class="tok-n">cfg</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_tls_config_own_cert.3tls.html b/man/tip/nng_tls_config_own_cert.3tls.html index 7c02dc00..0c9cb630 100644 --- a/man/tip/nng_tls_config_own_cert.3tls.html +++ b/man/tip/nng_tls_config_own_cert.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_own_cert(3tls) --- <h1>nng_tls_config_own_cert(3tls)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_tls_config_own_cert</span><span class="tok-p">(</span><span class="tok-n">nng_tls_config</span> <span class="tok-o">*</span><span class="tok-n">cfg</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">cert</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">key</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">pass</span><span class="tok-p">);</span></code></pre> </div> diff --git a/man/tip/nng_tls_config_server_name.3tls.html b/man/tip/nng_tls_config_server_name.3tls.html index 79ace5c9..cb800b4f 100644 --- a/man/tip/nng_tls_config_server_name.3tls.html +++ b/man/tip/nng_tls_config_server_name.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_server_name(3tls) --- <h1>nng_tls_config_server_name(3tls)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_tls_config_server_name</span><span class="tok-p">(</span><span class="tok-n">nng_tls_config</span> <span class="tok-o">*</span><span class="tok-n">cfg</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">name</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_tls_config_version.3tls.html b/man/tip/nng_tls_config_version.3tls.html index 34d6ebbf..f92f1ebe 100644 --- a/man/tip/nng_tls_config_version.3tls.html +++ b/man/tip/nng_tls_config_version.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_version(3tls) --- <h1>nng_tls_config_version(3tls)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">enum</span> <span class="tok-n">nng_tls_version</span> <span class="tok-p">{</span> <span class="tok-n">NNG_TLS_1_0</span> <span class="tok-o">=</span> <span class="tok-mh">0x301</span><span class="tok-p">,</span> <span class="tok-n">NNG_TLS_1_1</span> <span class="tok-o">=</span> <span class="tok-mh">0x302</span><span class="tok-p">,</span> diff --git a/man/tip/nng_tls_engine.5.html b/man/tip/nng_tls_engine.5.html index 55454339..b3d434af 100644 --- a/man/tip/nng_tls_engine.5.html +++ b/man/tip/nng_tls_engine.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_engine(5) --- <h1>nng_tls_engine(5)</h1> <div class="sect1"> @@ -16,9 +17,9 @@ layout: manpage_v2 <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"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/engine.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/engine.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_tls_engine_s</span> <span class="tok-n">nng_tls_engine</span><span class="tok-p">;</span></code></pre> </div> </div> diff --git a/man/tip/nng_tls_engine_description.3tls.html b/man/tip/nng_tls_engine_description.3tls.html index d63d6aac..e931e619 100644 --- a/man/tip/nng_tls_engine_description.3tls.html +++ b/man/tip/nng_tls_engine_description.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_engine_description(3tls) --- <h1>nng_tls_engine_description(3tls)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-nf">nng_tls_engine_description</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -29,7 +30,7 @@ layout: manpage_v2 <div class="paragraph"> <p>The <code>nng_tls_engine_description()</code> returns a short description for the current <a href="nng_tls_engine.5.html">TLS engine</a>. -If no engine is registered, then the empty string ("") is returned. +If no engine is registered, then the empty string ("") is returned. This is principally useful for diagnostic purposes.</p> </div> </div> diff --git a/man/tip/nng_tls_engine_fips_mode.3tls.html b/man/tip/nng_tls_engine_fips_mode.3tls.html index 87b4cf5e..6e587223 100644 --- a/man/tip/nng_tls_engine_fips_mode.3tls.html +++ b/man/tip/nng_tls_engine_fips_mode.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_engine_fips_mode(3tls) --- <h1>nng_tls_engine_fips_mode(3tls)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-kt">bool</span> <span class="tok-nf">nng_tls_engine_fips_mode</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_tls_engine_name.3tls.html b/man/tip/nng_tls_engine_name.3tls.html index 4282886d..69106875 100644 --- a/man/tip/nng_tls_engine_name.3tls.html +++ b/man/tip/nng_tls_engine_name.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_engine_name(3tls) --- <h1>nng_tls_engine_name(3tls)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/supplemental/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/tls/tls.h></span> + <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-nf">nng_tls_engine_name</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -29,7 +30,7 @@ layout: manpage_v2 <div class="paragraph"> <p>The <code>nng_tls_engine_name()</code> returns a short name for the current <a href="nng_tls_engine.5.html">TLS engine</a>. -If no engine is registered, then the special name "none" is returned.</p> +If no engine is registered, then the special name "none" is returned.</p> </div> </div> </div> diff --git a/man/tip/nng_tls_options.5.html b/man/tip/nng_tls_options.5.html index 9932709b..e5671549 100644 --- a/man/tip/nng_tls_options.5.html +++ b/man/tip/nng_tls_options.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_options(5) --- <h1>nng_tls_options(5)</h1> <div class="sect1"> @@ -16,14 +17,16 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> -<span class="tok-cp">#define NNG_OPT_TLS_AUTH_MODE "tls-authmode" -</span><span class="tok-cp">#define NNG_OPT_TLS_CA_FILE "tls-ca-file" -</span><span class="tok-cp">#define NNG_OPT_TLS_CERT_KEY_FILE "tls-cert-key-file" -</span><span class="tok-cp">#define NNG_OPT_TLS_CONFIG "tls-config" -</span><span class="tok-cp">#define NNG_OPT_TLS_SERVER_NAME "tls-server-name" -</span><span class="tok-cp">#define NNG_OPT_TLS_VERIFIED "tls-verified"</span></code></pre> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + +<span class="tok-cp">#define NNG_OPT_TLS_AUTH_MODE "tls-authmode"</span> +<span class="tok-cp">#define NNG_OPT_TLS_CA_FILE "tls-ca-file"</span> +<span class="tok-cp">#define NNG_OPT_TLS_CERT_KEY_FILE "tls-cert-key-file"</span> +<span class="tok-cp">#define NNG_OPT_TLS_CONFIG "tls-config"</span> +<span class="tok-cp">#define NNG_OPT_TLS_SERVER_NAME "tls-server-name"</span> +<span class="tok-cp">#define NNG_OPT_TLS_VERIFIED "tls-verified"</span> +<span class="tok-cp">#define NNG_OPT_TLS_PEER_CN "tls-peer-cn"</span> +<span class="tok-cp">#define NNG_OPT_TLS_PEER_ALT_NAMES "tls-peer-alt-names"</span></code></pre> </div> </div> </div> @@ -52,21 +55,21 @@ description of the option.</p> <h3 id="_tls_options">TLS Options</h3> <div class="dlist"> <dl> -<dt class="hdlist1">[[NNG_OPT_TLS_AUTH_MODE]]<code>NNG_OPT_TLS_AUTH_MODE</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_TLS_AUTH_MODE"></a><code>NNG_OPT_TLS_AUTH_MODE</code></dt> <dd> <p>(<code>int</code>) Write-only option used to configure the authentication mode used. See <a href="nng_tls_config_auth_mode.3tls.html"><code>nng_tls_config_auth_mode()</code></a> for more details.</p> </dd> -<dt class="hdlist1">[[NNG_OPT_TLS_CA_FILE]]<code>NNG_OPT_TLS_CA_FILE</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_TLS_CA_FILE"></a><code>NNG_OPT_TLS_CA_FILE</code></dt> <dd> <p>(string) Write-only option naming a file containing certificates to use for peer validation. See <a href="nng_tls_config_ca_file.3tls.html"><code>nng_tls_config_ca_file()</code></a> for more information.</p> </dd> -<dt class="hdlist1">[[NNG_OPT_TLS_CERT_KEY_FILE]]<code>NNG_OPT_TLS_CERT_KEY_FILE</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_TLS_CERT_KEY_FILE"></a><code>NNG_OPT_TLS_CERT_KEY_FILE</code></dt> <dd> <p>(string) Write-only option naming a file containing the local certificate and associated private key. @@ -74,7 +77,7 @@ The private key used must be unencrypted. See <a href="nng_tls_config_own_cert.3tls.html"><code>nng_tls_config_own_cert()</code></a> for more information.</p> </dd> -<dt class="hdlist1">[[NNG_OPT_TLS_CONFIG]]<code>NNG_OPT_TLS_CONFIG</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_TLS_CONFIG"></a><code>NNG_OPT_TLS_CONFIG</code></dt> <dd> <p>(<code>nng_tls_config *</code>) This option references the underlying @@ -108,7 +111,7 @@ Use this option when more advanced TLS configuration is required. </table> </div> </dd> -<dt class="hdlist1">[[NNG_OPT_TLS_SERVER_NAME]]<code>NNG_OPT_TLS_SERVER_NAME</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_TLS_SERVER_NAME"></a><code>NNG_OPT_TLS_SERVER_NAME</code></dt> <dd> <p>(string) This write-only option is used to specify the name of the server. @@ -117,13 +120,25 @@ indication, which is used as a hint by a multihosting server to choose the appropriate certificate to provide) and also is used to validate the name presented in the server’s x509 certificate.</p> </dd> -<dt class="hdlist1">[[NNG_OPT_TLS_VERIFIED]]<code>NNG_OPT_TLS_VERIFIED</code></dt> +<dt class="hdlist1"><a id="NNG_OPT_TLS_VERIFIED"></a><code>NNG_OPT_TLS_VERIFIED</code></dt> <dd> <p>(<code>bool</code>) This read-only option indicates whether the remote peer has been properly verified using TLS authentication. May return incorrect results if peer authentication is disabled.</p> </dd> +<dt class="hdlist1"><a id="NNG_OPT_TLS_PEER_CN"></a><code>NNG_OPT_TLS_PEER_CN</code></dt> +<dd> +<p>(string) +This read-only option returns the common name of the peer certificate. +May return incorrect results if peer authentication is disabled.</p> +</dd> +<dt class="hdlist1"><a id="NNG_OPT_TLS_PEER_ALT_NAMES"></a><code>NNG_OPT_TLS_PEER_ALT_NAMES</code></dt> +<dd> +<p>(string) +This read-only option returns string list with the subject alternative names of the +peer certificate. May return incorrect results if peer authentication is disabled.</p> +</dd> </dl> </div> </div> diff --git a/man/tip/nng_tls_register.3.html b/man/tip/nng_tls_register.3.html index 64c67d6f..1c61f130 100644 --- a/man/tip/nng_tls_register.3.html +++ b/man/tip/nng_tls_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_register(3) --- <h1>nng_tls_register(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/tls/tls.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/tls/tls.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_tls_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_url.5.html b/man/tip/nng_url.5.html index db244943..0d631d1f 100644 --- a/man/tip/nng_url.5.html +++ b/man/tip/nng_url.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_url(5) --- <h1>nng_url(5)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_url</span> <span class="tok-p">{</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_rawurl</span><span class="tok-p">;</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_scheme</span><span class="tok-p">;</span> @@ -65,7 +66,7 @@ alter them, as the underlying memory is managed by the library.</p> <code>u_scheme</code> </td> <td class="hdlist2"> -<p>The URL scheme, such as "http" or "inproc". Always lower case. This will never be <code>NULL</code>.</p> +<p>The URL scheme, such as "http" or "inproc". Always lower case. This will never be <code>NULL</code>.</p> </td> </tr> <tr> diff --git a/man/tip/nng_url_clone.3.html b/man/tip/nng_url_clone.3.html index 4feaad7c..27715560 100644 --- a/man/tip/nng_url_clone.3.html +++ b/man/tip/nng_url_clone.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_url_clone(3) --- <h1>nng_url_clone(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_url_clone</span><span class="tok-p">(</span><span class="tok-n">nng_url</span> <span class="tok-o">**</span><span class="tok-n">dup</span><span class="tok-p">,</span> <span class="tok-n">nng_url</span> <span class="tok-o">*</span><span class="tok-n">orig</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_url_free.3.html b/man/tip/nng_url_free.3.html index 80474e3e..8b0df134 100644 --- a/man/tip/nng_url_free.3.html +++ b/man/tip/nng_url_free.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_url_free(3) --- <h1>nng_url_free(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">void</span> <span class="tok-nf">nng_url_free</span><span class="tok-p">(</span><span class="tok-n">nng_url</span> <span class="tok-o">*</span><span class="tok-n">url</span><span class="tok-p">);</span></code></pre> </div> </div> diff --git a/man/tip/nng_url_parse.3.html b/man/tip/nng_url_parse.3.html index fbf863f7..469a4a7c 100644 --- a/man/tip/nng_url_parse.3.html +++ b/man/tip/nng_url_parse.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_url_parse(3) --- <h1>nng_url_parse(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_url_parse</span><span class="tok-p">(</span><span class="tok-n">nng_url</span> <span class="tok-o">**</span><span class="tok-n">urlp</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">str</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -50,34 +51,34 @@ follows:</p> </li> <li> <p>The <code>u_scheme</code>, <code>u_hostname</code>, <code>u_host</code>, and <code>u_port</code> members are - converted to lower case.</p> +converted to lower case.</p> </li> <li> <p>Percent-encoded values for - <a href="https://tools.ietf.org/html/rfc3986#section-2.3">unreserved characters</a> - converted to their unencoded forms.</p> +<a href="https://tools.ietf.org/html/rfc3986#section-2.3">unreserved characters</a> +converted to their unencoded forms.</p> </li> <li> <p>Additionally URL percent-encoded values for characters in the path - and with numeric values larger than 127 (i.e. not ASCII) are decoded.</p> +and with numeric values larger than 127 (i.e. not ASCII) are decoded.</p> </li> <li> <p>The resulting <code>u_path</code> is checked for invalid UTF-8 sequences, consisting - of surrogate pairs, illegal byte sequences, or overlong encodings. - If this check fails, then the entire URL is considered invalid, and - the function returns <code>NNG_EINVAL</code>.</p> +of surrogate pairs, illegal byte sequences, or overlong encodings. +If this check fails, then the entire URL is considered invalid, and +the function returns <code>NNG_EINVAL</code>.</p> </li> <li> <p>Path segments consisting of <code>.</code> and <code>..</code> are resolved as per - <a href="https://tools.ietf.org/html/rfc3986#section-6.2.2.3">RFC 3986 6.2.2.3</a>.</p> +<a href="https://tools.ietf.org/html/rfc3986#section-6.2.2.3">RFC 3986 6.2.2.3</a>.</p> </li> <li> <p>Further, empty path segments are removed, meaning that duplicate - slash (<code>/</code>) separators are removed from the path.</p> +slash (<code>/</code>) separators are removed from the path.</p> </li> <li> <p>If a port was not specified, but the scheme defines a default - port, then <code>u_port</code> will be filled in with the value of the default port.</p> +port, then <code>u_port</code> will be filled in with the value of the default port.</p> </li> </ol> </div> diff --git a/man/tip/nng_version.3.html b/man/tip/nng_version.3.html index abd2b4e7..0993cb3b 100644 --- a/man/tip/nng_version.3.html +++ b/man/tip/nng_version.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_version(3) --- <h1>nng_version(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/nng.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span> + <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span> <span class="tok-nf">nng_version</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -67,7 +68,7 @@ via some predefined macros:</p> <a href="http://www.semver.org">Semantic Versioning 2.0</a>, and the version numbers reported refer to both the API and the library itself. -(The ABI -- application binary interface -- between the +(The ABI — application binary interface — between the library and the application is controlled in a similar, but different manner depending upon the link options and how the library is built.)</p> </div> diff --git a/man/tip/nng_ws.7.html b/man/tip/nng_ws.7.html index dd252cc5..fc54b683 100644 --- a/man/tip/nng_ws.7.html +++ b/man/tip/nng_ws.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ws(7) --- <h1>nng_ws(7)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/websocket/ws.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/websocket/ws.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_ws_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span> <span class="tok-kt">int</span> <span class="tok-nf">nng_wss_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> @@ -28,7 +29,7 @@ layout: manpage_v2 <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> <div class="paragraph"> -<p>(transport, <em>ws</em> and <em>wss</em>) +<p>(transport, <em>ws</em> and _wss_) The <em>ws</em> transport provides communication support between peers across a TCP/IP network using <a href="https://tools.ietf.org/html/rfc6455">WebSockets</a>. @@ -329,6 +330,17 @@ more details.</p> authentication. May return incorrect results if peer authentication is disabled.</p> </dd> +<dt class="hdlist1"><code>NNG_OPT_TLS_PEER_CN</code></dt> +<dd> +<p>(string) This read-only option returns the common name of the peer certificate. +May return incorrect results if peer authentication is disabled.</p> +</dd> +<dt class="hdlist1"><code>NNG_OPT_TLS_PEER_ALT_NAMES</code></dt> +<dd> +<p>(string list) returns string list with the subject alternative names of the +peer certificate. May return incorrect results if peer authentication +is disabled.</p> +</dd> </dl> </div> </div> diff --git a/man/tip/nng_ws_register.3.html b/man/tip/nng_ws_register.3.html index ddebc167..b8a8f2b6 100644 --- a/man/tip/nng_ws_register.3.html +++ b/man/tip/nng_ws_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ws_register(3) --- <h1>nng_ws_register(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/websocket/ws.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/websocket/ws.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_ws_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -30,6 +31,19 @@ layout: manpage_v2 <p>The <code>nng_ws_register()</code> function registers the <em>ws</em> transport(transport, <em>ws</em>) for use.</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 deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +</td> +</tr> +</table> +</div> </div> </div> <div class="sect1"> diff --git a/man/tip/nng_wss_register.3.html b/man/tip/nng_wss_register.3.html index 76a05883..f2b09090 100644 --- a/man/tip/nng_wss_register.3.html +++ b/man/tip/nng_wss_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_wss_register(3) --- <h1>nng_wss_register(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/websocket/ws.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/websocket/ws.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_wss_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -30,6 +31,19 @@ layout: manpage_v2 <p>The <code>nng_wss_register()</code> function registers the <em>wss</em> transport(transport, <em>wss</em>) for use.</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 deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +</td> +</tr> +</table> +</div> </div> </div> <div class="sect1"> diff --git a/man/tip/nng_zerotier.7.html b/man/tip/nng_zerotier.7.html index 0f818434..3f0a924b 100644 --- a/man/tip/nng_zerotier.7.html +++ b/man/tip/nng_zerotier.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_zerotier(7) --- <h1>nng_zerotier(7)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/zerotier/zerotier.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/zerotier/zerotier.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_zt_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -70,7 +71,7 @@ and adhere to the licensing terms. </td> <td class="content"> The ZeroTier transport can take a long time to establish an -initial connection -- up to even a minute in extreme cases, while the network +initial connection — up to even a minute in extreme cases, while the network topology is configured. Consequently, this transport is not recommended for use cases involving short-lived programs, but is better for long-running programs such as background daemons or agents. @@ -146,7 +147,7 @@ the actual structure is of type <div class="sect2"> <h3 id="_node_presence">Node Presence</h3> <div class="paragraph"> -<p>By default this transport creates an "ephemeral" node, and used the +<p>By default this transport creates an "ephemeral" node, and used the same ephemeral node for any additional endpoints created. As this node is ephemeral, the keys associated with it and all associated data are located in memory and are discarded upon application termination. @@ -211,12 +212,12 @@ The network is most likely not available.</p> <dt class="hdlist1"><code>NNG_OPT_ZT_HOME</code></dt> <dd> <p>(string) This option represents the home directory, where the transport - can store (and reuse) persistent state, such as key materials, node - identity, and federation membership. - This option must be set before the ZeroTier transport is first used. - If this value is empty, then an ephemeral ZeroTier node is created, - and no persistent state is used. - The default is to use an ephemeral node.</p> +can store (and reuse) persistent state, such as key materials, node +identity, and federation membership. +This option must be set before the ZeroTier transport is first used. +If this value is empty, then an ephemeral ZeroTier node is created, +and no persistent state is used. +The default is to use an ephemeral node.</p> <div class="admonitionblock note"> <table> <tr> @@ -251,8 +252,9 @@ in this fashion. <dl> <dt class="hdlist1"><code>NNG_OPT_ZT_NETWORK_STATUS</code></dt> <dd> -<p> (<code>int</code>) The ZeroTier network status. - See <a href="#Network Status">[Network Status]</a> for an explanation of this option.</p> +<p> +(<code>int</code>) The ZeroTier network status. +See <a href="#_network_status">Network Status</a> for an explanation of this option.</p> </dd> </dl> </div> @@ -260,8 +262,9 @@ in this fashion. <dl> <dt class="hdlist1"><code>NNG_OPT_ZT_NETWORK_NAME</code></dt> <dd> -<p> (string) The name of the network - as established by the ZeroTier network administrator.</p> +<p> +(string) The name of the network +as established by the ZeroTier network administrator.</p> </dd> </dl> </div> @@ -270,9 +273,9 @@ in this fashion. <dt class="hdlist1"><code>NNG_OPT_ZT_CONN_TIME</code></dt> <dd> <p>(<a href="nng_duration.5.html"><code>nng_duration</code></a>) - The time to wait between sending connection attempts, - only used with dialers. - The default is 500 msec.</p> +The time to wait between sending connection attempts, +only used with dialers. +The default is 500 msec.</p> </dd> </dl> </div> @@ -281,10 +284,10 @@ in this fashion. <dt class="hdlist1"><code>NNG_OPT_ZT_CONN_TRIES</code></dt> <dd> <p>(<code>int</code>) The maximum number of attempts to try to establish a connection - before reporting a timeout, and is only used with dialers. - The default is 240, which results in a 2 minute timeout if - <code>NNG_OPT_ZT_CONN_TIME</code> is at its default of 500. - If the value is set to 0, then connection attempts will keep retrying forever.</p> +before reporting a timeout, and is only used with dialers. +The default is 240, which results in a 2 minute timeout if +<code>NNG_OPT_ZT_CONN_TIME</code> is at its default of 500. +If the value is set to 0, then connection attempts will keep retrying forever.</p> </dd> </dl> </div> @@ -293,9 +296,9 @@ in this fashion. <dt class="hdlist1"><code>NNG_OPT_ZT_PING_TIME</code></dt> <dd> <p>(<a href="nng_duration.5.html"><code>nng_duration</code></a>) If no traffic has been received from - the ZeroTier peer after this - period of time, then a ping message is sent to check if the peer - is still alive.</p> +the ZeroTier peer after this +period of time, then a ping message is sent to check if the peer +is still alive.</p> </dd> </dl> </div> @@ -304,8 +307,8 @@ in this fashion. <dt class="hdlist1"><code>NNG_OPT_ZT_PING_TRIES</code></dt> <dd> <p>(<code>int</code>) If this number of consecutive ping requests are sent to the - peer with no response (and no other intervening traffic), then the - peer is assumed to be dead and the connection is closed.</p> +peer with no response (and no other intervening traffic), then the +peer is assumed to be dead and the connection is closed.</p> </dd> </dl> </div> @@ -314,10 +317,10 @@ in this fashion. <dt class="hdlist1"><code>NNG_OPT_ZT_MTU</code></dt> <dd> <p>(<code>size_t</code>) The ZeroTier virtual network MTU (read-only) as configured - on the network; this is the Virtual Layer 2 MTU. The headers used by - this transport and the protocols consume some of this for each message - sent over the network. (The transport uses 20-bytes of this, and each - protocol may consume additional space, typically not more than 16-bytes.)</p> +on the network; this is the Virtual Layer 2 MTU. The headers used by +this transport and the protocols consume some of this for each message +sent over the network. (The transport uses 20-bytes of this, and each +protocol may consume additional space, typically not more than 16-bytes.)</p> </dd> </dl> </div> @@ -326,9 +329,9 @@ in this fashion. <dt class="hdlist1"><code>NNG_OPT_ZT_ORBIT</code></dt> <dd> <p>(<code>uint64_t[2]</code>) Write-only array of two <code>uint64_t</code> values, - indicating the ID of a ZeroTier <em>moon</em>, and the node ID of the root server - for that moon. (The ID may be zero if the moon ID is the same as its - root server ID, which is conventional.)</p> +indicating the ID of a ZeroTier <em>moon</em>, and the node ID of the root server +for that moon. (The ID may be zero if the moon ID is the same as its +root server ID, which is conventional.)</p> </dd> </dl> </div> @@ -337,7 +340,7 @@ in this fashion. <dt class="hdlist1"><code>NNG_OPT_ZT_DEORBIT</code></dt> <dd> <p>(<code>uint64_t</code>) Write-only option indicating the moon ID to deorbit. - If the node is not already orbiting the moon, then this has no effect.</p> +If the node is not already orbiting the moon, then this has no effect.</p> </dd> </dl> </div> diff --git a/man/tip/nng_zt_register.3.html b/man/tip/nng_zt_register.3.html index 2ac24e28..21764bad 100644 --- a/man/tip/nng_zt_register.3.html +++ b/man/tip/nng_zt_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_zt_register(3) --- <h1>nng_zt_register(3)</h1> <div class="sect1"> @@ -16,8 +17,8 @@ layout: manpage_v2 <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"><nng/transport/zerotier/zerotier.h></span><span class="tok-cp"> -</span><span class="tok-cp"></span> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/transport/zerotier/zerotier.h></span> + <span class="tok-kt">int</span> <span class="tok-nf">nng_zt_register</span><span class="tok-p">(</span><span class="tok-kt">void</span><span class="tok-p">);</span></code></pre> </div> </div> @@ -30,6 +31,19 @@ layout: manpage_v2 <p>The <code>nng_zt_register()</code> function registers the <em>zt</em> transport(transport, <em>zt</em>) for use.</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 deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +</td> +</tr> +</table> +</div> </div> </div> <div class="sect1"> diff --git a/man/tip/nngcat.1.html b/man/tip/nngcat.1.html index 2ca4087e..a640c1db 100644 --- a/man/tip/nngcat.1.html +++ b/man/tip/nngcat.1.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nngcat(1) --- <h1>nngcat(1)</h1> <div class="sect1"> @@ -97,33 +98,33 @@ each option must be presented as a separate argument to the program.</p> </dd> <dt class="hdlist1"><strong>--compat</strong></dt> <dd> -<p>Compatible mode. - This cause <em>nngcat</em> to behave more like the legacy - <em>nanocat</em> application. - In this mode connections are made asynchronously, - and the <strong>--pair</strong> option selects version 0 of - the <a href="nng_pair.7.html"><em>pair</em></a> protocol instead of version 1.</p> +<p>Compatible mode. +This cause <em>nngcat</em> to behave more like the legacy +<em>nanocat</em> application. +In this mode connections are made asynchronously, +and the <strong>--pair</strong> option selects version 0 of +the <a href="nng_pair.7.html"><em>pair</em></a> protocol instead of version 1.</p> </dd> <dt class="hdlist1"><strong>--subscribe</strong>=<em>TOPIC</em></dt> <dd> <p>Subscribe to <em>TOPIC</em>. This option can only be used with the - <a href="nng_sub.7.html"><em>sub</em></a> protocol. - The <em>TOPIC</em> is checked against the first bytes - of messages received, and messages are discarded if they do not match. - This may be specified multiple times to subscribe to multiple topics. - If not specified at all, then a default subscription to everything is assumed.</p> +<a href="nng_sub.7.html"><em>sub</em></a> protocol. +The <em>TOPIC</em> is checked against the first bytes +of messages received, and messages are discarded if they do not match. +This may be specified multiple times to subscribe to multiple topics. +If not specified at all, then a default subscription to everything is assumed.</p> </dd> <dt class="hdlist1"><strong>--count=</strong>=<em>COUNT</em></dt> <dd> <p>Limit the number of iterations when looping to <em>COUNT</em> iterations. - For protocols that only send, this will only send <em>COUNT</em> messages before - exiting. - For protocols that only receive, this will only receive <em>COUNT</em> messages - before exiting. - For protocols that involve a full exchange, this will only perform <em>COUNT</em> - exchanges (each exchange is characterized by at most a single send, and - one or more receives.) - If <em>COUNT</em> is zero, then an infinite number of iterations is performed.</p> +For protocols that only send, this will only send <em>COUNT</em> messages before +exiting. +For protocols that only receive, this will only receive <em>COUNT</em> messages +before exiting. +For protocols that involve a full exchange, this will only perform <em>COUNT</em> +exchanges (each exchange is characterized by at most a single send, and +one or more receives.) +If <em>COUNT</em> is zero, then an infinite number of iterations is performed.</p> </dd> </dl> </div> @@ -147,75 +148,75 @@ At least one protocol must be selected. <dt class="hdlist1"><strong>--bus, --bus0</strong></dt> <dd> <p>Select the <a href="nng_bus.7.html"><em>bus</em></a> version 0 protocol. - This protocol can send and receive messages to and from other <em>bus</em> version 0 - peers.</p> +This protocol can send and receive messages to and from other <em>bus</em> version 0 +peers.</p> </dd> <dt class="hdlist1"><strong>--req, --req0</strong></dt> <dd> <p>Select the <a href="nng_req.7.html"><em>req</em></a> version 0 protocol. - This protocol sends messages to <a href="nng_rep.7.html"><em>rep</em></a> version 0 - peers and receives replies from them.</p> +This protocol sends messages to <a href="nng_rep.7.html"><em>rep</em></a> version 0 +peers and receives replies from them.</p> </dd> <dt class="hdlist1"><strong>--rep, --rep0</strong></dt> <dd> <p>Select the <a href="nng_rep.7.html"><em>rep</em></a> version 0 protocol. - This protocol receives messages from <a href="nng_req.7.html"><em>req</em></a> version 0 peers - and can send replies to them.</p> +This protocol receives messages from <a href="nng_req.7.html"><em>req</em></a> version 0 peers +and can send replies to them.</p> </dd> <dt class="hdlist1"><strong>--pub, --pub0</strong></dt> <dd> <p>Select the <a href="nng_pub.7.html"><em>pub</em></a> version 0 protocol. - This protocol sends messages to <a href="nng_sub.7.html"><em>sub</em></a> version peers.</p> +This protocol sends messages to <a href="nng_sub.7.html"><em>sub</em></a> version peers.</p> </dd> <dt class="hdlist1"><strong>--sub, --sub0</strong></dt> <dd> <p>Select the <a href="nng_sub.7.html"><em>sub</em></a> version 0 protocol. - This protocol receives messages from <a href="nng_pub.7.html"><em>pub</em></a> version - 0 peers, and filters them based on subscriptions set with <strong>--subscribe</strong>.</p> +This protocol receives messages from <a href="nng_pub.7.html"><em>pub</em></a> version +0 peers, and filters them based on subscriptions set with <strong>--subscribe</strong>.</p> </dd> <dt class="hdlist1"><strong>--push, --push0</strong></dt> <dd> <p>Select the <a href="nng_push.7.html"><em>push</em></a> version 0 protocol. - This protocol sends messages to <a href="nng_pull.7.html"><em>pull</em></a> version 0 peers. - A given message is normally only delivered to a single peer.</p> +This protocol sends messages to <a href="nng_pull.7.html"><em>pull</em></a> version 0 peers. +A given message is normally only delivered to a single peer.</p> </dd> <dt class="hdlist1"><strong>--pull, --pull0</strong></dt> <dd> <p>Select the <a href="nng_pull.7.html"><em>pull</em></a> version 0 protocol. - This protocol receives - messages from <a href="nng_push.7.html"><em>push</em></a> version 0 peers.</p> +This protocol receives +messages from <a href="nng_push.7.html"><em>push</em></a> version 0 peers.</p> </dd> <dt class="hdlist1"><strong>--pair0</strong></dt> <dd> <p>Select the <a href="nng_pair.7.html"><em>pair</em></a> version 0 protocol. - This protocol can send and receive messages with one connected <em>pair</em> - version 0 peer.</p> +This protocol can send and receive messages with one connected <em>pair</em> +version 0 peer.</p> </dd> <dt class="hdlist1"><strong>--pair1</strong></dt> <dd> <p>Select the <a href="nng_pair.7.html"><em>pair</em></a> version 1 protocol. - This protocol can send and receive messages with one connected <em>pair</em> - version 1 peer. - It is not supported in <strong>--compat</strong> mode. - (Polyamorous mode is not supported - in <em>nngcat</em>, although peers may be using polyamorous mode.)</p> +This protocol can send and receive messages with one connected <em>pair</em> +version 1 peer. +It is not supported in <strong>--compat</strong> mode. +(Polyamorous mode is not supported +in <em>nngcat</em>, although peers may be using polyamorous mode.)</p> </dd> <dt class="hdlist1"><strong>--pair</strong></dt> <dd> <p>Acts as an alias for <strong>--pair1</strong>, unless <strong>--compat</strong> mode is selected, in - which case it acts as an alias for <strong>--pair0</strong>.</p> +which case it acts as an alias for <strong>--pair0</strong>.</p> </dd> <dt class="hdlist1"><strong>--surveyor, --surveyor0</strong></dt> <dd> <p>Select the <a href="nng_surveyor.7.html"><em>surveyor</em></a> version 0 protocol. - This protocol sends a survey request to <a href="nng_respondent.7.html"><em>respondent</em></a> - version 0 peers, and then receives replies from them.</p> +This protocol sends a survey request to <a href="nng_respondent.7.html"><em>respondent</em></a> +version 0 peers, and then receives replies from them.</p> </dd> <dt class="hdlist1"><strong>--respondent, --respondent0</strong></dt> <dd> <p>Select the <a href="nng_respondent.7.html"><em>respondent</em></a> version 0 protocol. - This protocol receives survey requests from <a href="nng_surveyor.7.html"><em>surveyor</em></a> - version 0 peers, and can send a reply to them.</p> +This protocol receives survey requests from <a href="nng_surveyor.7.html"><em>surveyor</em></a> +version 0 peers, and can send a reply to them.</p> </dd> </dl> </div> @@ -260,22 +261,22 @@ more than one peer on a given connection. <dt class="hdlist1"><strong>-x, --connect-ipc</strong>=<em>PATH</em></dt> <dd> <p>Connect to the IPC path specified by <em>PATH</em>. This is the same as - <strong>--connect</strong>=ipc://<em>PATH</em>.</p> +<strong>--connect</strong>=ipc://<em>PATH</em>.</p> </dd> <dt class="hdlist1"><strong>-X, --bind-ipc</strong>=<em>PATH</em></dt> <dd> <p>Bind to the IPC path specified by <em>PATH</em>. This is the same as - <strong>--bind</strong>=ipc://<em>PATH</em>.</p> +<strong>--bind</strong>=ipc://<em>PATH</em>.</p> </dd> <dt class="hdlist1"><strong>-l, --connect-local</strong>=<em>PORT</em></dt> <dd> <p>Connect to <code>localhost</code> at the TCP port specified by <em>PORT</em>. This is the same - as <strong>--connect</strong>=tcp://127.0.0.1:<em>PORT</em>.</p> +as <strong>--connect</strong>=tcp://127.0.0.1:<em>PORT</em>.</p> </dd> <dt class="hdlist1"><strong>-L, --bind-local</strong>=<em>PORT</em></dt> <dd> <p>Bind to the TCP port specified by <em>PORT</em>. This is the same as - <strong>--bind</strong>=tcp://127.0.0.1:<em>PORT</em>.</p> +<strong>--bind</strong>=tcp://127.0.0.1:<em>PORT</em>.</p> </dd> </dl> </div> @@ -312,14 +313,14 @@ receives messages.</p> <dt class="hdlist1"><strong>--receive-timeout</strong>=<em>SEC</em></dt> <dd> <p>Give up receiving messages after <em>SEC</em> seconds pass without any received - messages.</p> +messages.</p> </dd> <dt class="hdlist1"><strong>--recv-maxsz</strong>=<em>COUNT</em></dt> <dd> <p>Set the maximum message size socket will accept to <em>COUNT</em> bytes. - Messages larger than this will be discarded. - The default is 1048576 (1 MB). - To eliminate any restriction, use 0.</p> +Messages larger than this will be discarded. +The default is 1048576 (1 MB). +To eliminate any restriction, use 0.</p> </dd> <dt class="hdlist1"><strong>--format</strong>=<em>FORMAT</em></dt> <dd> @@ -346,11 +347,12 @@ conventions.</p> </dd> <dt class="hdlist1"><code>hex</code></dt> <dd> -<p> Messages are printed as quoted strings, with every byte appearing as an escaped hexadecimal value, such as <code>\x2E</code>.</p> +<p>Messages are printed as quoted strings, with every byte appearing as an escaped hexadecimal value, such as <code>\x2E</code>.</p> </dd> <dt class="hdlist1"><code>msgpack</code></dt> <dd> -<p>Messages are emitted as <a href="https://msgpack.org">MessagePack</a> "bin format" +<p> +Messages are emitted as <a href="https://msgpack.org">MessagePack</a> "bin format" (byte arrays).</p> </dd> </dl> @@ -377,14 +379,14 @@ conventions.</p> <dt class="hdlist1"><strong>-i, --interval</strong>=<em>SEC</em></dt> <dd> <p>For protocols that send unsolicited data (as opposed to those that - send data only in response to received messages), this will resend the - outgoing message at repeating intervals of <em>SEC</em> seconds.</p> +send data only in response to received messages), this will resend the +outgoing message at repeating intervals of <em>SEC</em> seconds.</p> </dd> <dt class="hdlist1"><strong>-d, --delay</strong>=<em>SEC</em></dt> <dd> <p>Wait <em>SEC</em> seconds before sending the first outgoing message. - This is useful to let connections establish before sending data, thereby - avoiding message loss.</p> +This is useful to let connections establish before sending data, thereby +avoiding message loss.</p> </dd> <dt class="hdlist1"><strong>--send-timeout</strong>=<em>SEC</em></dt> <dd> @@ -412,15 +414,15 @@ when using addresses that are not secured with TLS.</p> <dt class="hdlist1"><strong>--key</strong>=<em>FILE</em></dt> <dd> <p>Load own key from <em>FILE</em>. - Should be used in conjunction with <strong>--cert</strong>. - If not specified, and <strong>--cert</strong> is specified, then a single file containing both - the private key and the associated certificate is assumed.</p> +Should be used in conjunction with <strong>--cert</strong>. +If not specified, and <strong>--cert</strong> is specified, then a single file containing both +the private key and the associated certificate is assumed.</p> </dd> <dt class="hdlist1"><strong>--cacert</strong>=<em>FILE</em></dt> <dd> <p>Load CA certificates from <em>FILE</em>. - These CAs ("Certificate Authorities") are - used as trust roots when validating certificates presented by peers.</p> +These CAs ("Certificate Authorities") are +used as trust roots when validating certificates presented by peers.</p> </dd> </dl> </div> @@ -436,9 +438,9 @@ otherwise.</p> <dt class="hdlist1"><strong>--zt-home</strong>=<em>DIRECTORY</em></dt> <dd> <p>Directory for persistent ZeroTier node (key material, etc.) - This directory must already exist. - Only one program may use a ZeroTier node at a time; - file locking is used to prevent this.</p> +This directory must already exist. +Only one program may use a ZeroTier node at a time; +file locking is used to prevent this.</p> </dd> </dl> </div> |