diff options
Diffstat (limited to 'man/tip/libnng.3.html')
| -rw-r--r-- | man/tip/libnng.3.html | 176 |
1 files changed, 173 insertions, 3 deletions
diff --git a/man/tip/libnng.3.html b/man/tip/libnng.3.html index 2d374ca0..caa480fd 100644 --- a/man/tip/libnng.3.html +++ b/man/tip/libnng.3.html @@ -527,6 +527,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b <li><a href="#_url_object">URL Object</a></li> <li><a href="#_supplemental_api">Supplemental API</a></li> <li><a href="#_supplemental_tcp">Supplemental TCP</a></li> +<li><a href="#_supplemental_ipc">Supplemental IPC</a></li> <li><a href="#_http_support">HTTP Support</a></li> <li><a href="#_tls_configuration_objects">TLS Configuration Objects</a></li> </ul> @@ -879,7 +880,7 @@ mode may need to access the header of messages. <h3 id="_asynchronous_operations">Asynchronous Operations</h3> <div class="paragraph"> <p>Most applications will interact with <em>nng</em> synchronously; that is that -functions such as <code><a href="nng_send.3">nng_send()</a></code> will block the calling +functions such as <a href="nng_send.3"><code>nng_send()</code></a> will block the calling thread until the operation has completed.</p> </div> <div class="admonitionblock note"> @@ -905,7 +906,7 @@ of whether this was successful or not), then a user supplied function (“callback”) is executed.</p> </div> <div class="paragraph"> -<p>A context structure, an <code><a href="nng_aio.5">nng_aio</a></code>, is allocated and +<p>A context structure, an <a href="nng_aio.5"><code>nng_aio</code></a>, is allocated and associated with each asynchronous operation. Only a single asynchronous operation may be associated with an <code>nng_aio</code> at any time.</p> @@ -1409,6 +1410,98 @@ Most applications won’t need to use these.</p> </table> </div> <div class="sect2"> +<h3 id="_supplemental_ipc">Supplemental IPC</h3> +<div class="paragraph"> +<p>These IPC functions are available for use with direct interprocess +communication (IPC). +Most applications won’t need to use these.</p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_close.3ipc">nng_ipc_close()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">close IPC connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_dialer_alloc.3ipc">nng_ipc_dialer_alloc()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">allocate IPC dialer</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_dialer_close.3ipc">nng_ipc_dialer_close()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">close IPC dialer</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_dialer_dial.3ipc">nng_ipc_dialer_dial()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">initiate outgoing IPC connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_dialer_free.3ipc">nng_ipc_dialer_free()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">free IPC dialer</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_dialer_getopt.3ipc">nng_ipc_dialer_getopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">get option from IPC dialer</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_dialer_setopt.3ipc">nng_ipc_dialer_setopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">set option on IPC dialer</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_free.3ipc">nng_ipc_free()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">free IPC connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_getopt.3ipc">nng_ipc_getopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">get option from IPC connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_listener_accept.3ipc">nng_ipc_listener_accept()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">accept incoming IPC connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_listener_alloc.3ipc">nng_ipc_listener_alloc()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">allocate IPC listener</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_listener_close.3ipc">nng_ipc_listener_close()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">close IPC listener</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_listener_free.3ipc">nng_ipc_listener_free()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">free IPC listener</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_listener_getopt.3ipc">nng_ipc_listener_getopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">get option from IPC listener</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_listener_listen.3ipc">nng_ipc_listener_listen()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bind IPC listener</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_listener_setopt.3ipc">nng_ipc_listener_setopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">set option on IPC listener</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_recv.3ipc">nng_ipc_recv()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">receive from IPC connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_send.3ipc">nng_ipc_send()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">send to IPC connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_ipc_setopt.3ipc">nng_ipc_setopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">set option on IPC connection</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect2"> <h3 id="_http_support">HTTP Support</h3> <div class="paragraph"> <p>The library may be configured with support for HTTP, and this will @@ -1740,7 +1833,8 @@ and connections.</p> <h3 id="_tls_configuration_objects">TLS Configuration Objects</h3> <div class="paragraph"> <p>The following functions are used to manipulate transport layer security -(TLS) configuration objects.</p> +(TLS) configuration objects. Most of these functions will not be used even +by TLS applications.</p> </div> <div class="admonitionblock note"> <table> @@ -1762,6 +1856,10 @@ with TLS support. </colgroup> <tbody> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_close.3tls">nng_tls_close()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">close TLS connection</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_config_alloc.3tls">nng_tls_config_alloc()</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">allocate TLS configuration</p></td> </tr> @@ -1793,6 +1891,78 @@ with TLS support. <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_config_server_name.3tls">nng_tls_config_server_name()</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">set remote server name</p></td> </tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_dialer_alloc.3tls">nng_tls_dialer_alloc()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">allocate TLS dialer</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_dialer_close.3tls">nng_tls_dialer_close()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">close TLS dialer</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_dialer_dial.3tls">nng_tls_dialer_dial()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">initiate outgoing TLS connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_dialer_free.3tls">nng_tls_dialer_free()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">free TLS dialer</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_dialer_getopt.3tls">nng_tls_dialer_getopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">get option from TLS dialer</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_dialer_setopt.3tls">nng_tls_dialer_setopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">set option on TLS dialer</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_free.3tls">nng_tls_free()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">free TLS connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_getopt.3tls">nng_tls_getopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">get option from TLS connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_listener_accept.3tls">nng_tls_listener_accept()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">accept incoming TLS connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_listener_alloc.3tls">nng_tls_listener_alloc()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">allocate TLS listener</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_listener_close.3tls">nng_tls_listener_close()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">close TLS listener</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_listener_free.3tls">nng_tls_listener_free()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">free TLS listener</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_listener_getopt.3tls">nng_tls_listener_getopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">get option from TLS listener</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_listener_listen.3tls">nng_tls_listener_listen()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bind TLS listener to port</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_listener_setopt.3tls">nng_tls_listener_setopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">set option on TLS listener</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_recv.3tls">nng_tls_recv()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">receive from TLS connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_send.3tls">nng_tls_send()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">send to TLS connection</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="nng_tls_setopt.3tls">nng_tls_setopt()</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">set option on TLS connection</p></td> +</tr> </tbody> </table> </div> |