diff options
Diffstat (limited to 'man/v1.2.4/nng_tls.5.html')
| -rw-r--r-- | man/v1.2.4/nng_tls.5.html | 172 |
1 files changed, 172 insertions, 0 deletions
diff --git a/man/v1.2.4/nng_tls.5.html b/man/v1.2.4/nng_tls.5.html new file mode 100644 index 00000000..6c0dd42d --- /dev/null +++ b/man/v1.2.4/nng_tls.5.html @@ -0,0 +1,172 @@ +--- +version: v1.2.4 +layout: refman +--- +<!DOCTYPE html> +<html lang="en"> +<head> +<meta charset="UTF-8"> +<meta http-equiv="X-UA-Compatible" content="IE=edge"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<meta name="generator" content="Asciidoctor 2.0.10"> +<title>nng_tls(5)</title> +<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"> +<link rel="stylesheet" href="./asciidoctor.css"> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> +</head> +<body class="manpage toc2 toc-left"> +<div id="header"> +<h1>nng_tls(5) Manual Page</h1> +<div id="toc" class="toc2"> +<div id="toctitle">Table of Contents</div> +<ul class="sectlevel1"> +<li><a href="#_synopsis">SYNOPSIS</a></li> +<li><a href="#_description">DESCRIPTION</a> +<ul class="sectlevel2"> +<li><a href="#_options">Options</a></li> +</ul> +</li> +<li><a href="#_see_also">SEE ALSO</a></li> +</ul> +</div> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<p>nng_tls - TLS over TCP connection</p> +</div> +</div> +<div id="content"> +<div class="sect1"> +<h2 id="_synopsis">SYNOPSIS</h2> +<div class="sectionbody"> +<div class="listingblock"> +<div class="content"> +<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-cp">#include</span> <span class="tok-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-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_tls_s</span> <span class="tok-n">nng_tls</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>An <code>nng_tls</code> represents a connected stream. +TLS stream objects can be used to send or receive data, and +provide transport level security via cryptography over a TCP connected +stream.</p> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +The <code>nng_tls</code> object is used for raw TLS connections, and +should not be confused with a pipe object created using the +<a href="nng_tls.7.html">nng_tls(7)</a> transport. +</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"> +Most NNG applications should not use this, but instead use the +<a href="nng_tls.7.html">nng_tls(7)</a> transport instead. +</td> +</tr> +</table> +</div> +<div class="paragraph"> +<p>These objects are created either establishing an outgoing connection +with <a href="nng_tls_dialer_dial.3tls.html"><code>nng_tls_dialer_dial()</code></a> or by +accepting in incoming connection with +<a href="nng_tls_listener_accept.3tls.html"><code>nng_tls_listener_accept()</code></a>.</p> +</div> +<div class="paragraph"> +<p>TLS connections are byte streams, and are “reliable” in that data +will not be delivered out of order, or with portions missing.</p> +</div> +<div class="paragraph"> +<p>Data can be sent using <a href="nng_tls_send.3tls.html"><code>nng_tls_send()</code></a> or +received with <a href="nng_tls_recv.3tls.html"><code>nng_tls_recv()</code></a>.</p> +</div> +<div class="paragraph"> +<p>When the connection is no longer needed, it should be freed with +<a href="nng_tls_free.3tls.html"><code>nng_tls_free()</code></a>.</p> +</div> +<div class="admonitionblock tip"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-tip" title="Tip"></i> +</td> +<td class="content"> +It is possible to close the connection, without freeing it, by +using <a href="nng_tls_close.3tls.html"><code>nng_tls_close()</code></a>. +</td> +</tr> +</table> +</div> +<div class="sect2"> +<h3 id="_options">Options</h3> +<div class="paragraph"> +<p>The following options are applicable to TLS connections, and may be +accessed using the <a href="nng_tls_getopt.3tls.html"><code>nng_tls_getopt()</code></a> and +<a href="nng_tls_setopt.3tls.html"><code>nng_tls_setopt()</code></a> functions.</p> +</div> +<div class="ulist"> +<ul> +<li> +<p><a href="nng_options.5.html#NNG_OPT_LOCADDR"><code>NNG_OPT_LOCADDR</code></a></p> +</li> +<li> +<p><a href="nng_options.5.html#NNG_OPT_REMADDR"><code>NNG_OPT_REMADDR</code></a></p> +</li> +<li> +<p><a href="nng_tcp_options.5.html#NNG_OPT_TCP_KEEPALIVE"><code>NNG_OPT_TCP_KEEPALIVE</code></a></p> +</li> +<li> +<p><a href="nng_tcp_options.5.html#NNG_OPT_TCP_NO_DELAY"><code>NNG_OPT_TCP_NODELAY</code></a></p> +</li> +<li> +<p><a href="nng_tls_options.5.html#NNG_OPT_TLS_VERIFIED"><code>NNG_OPT_TLS_VERIFIED</code></a></p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>Other platform specific options may be available as well.</p> +</div> +</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_tls_close.3tls.html">nng_tls_close(3tls)</a>, +<a href="nng_tls_dialer_dial.3tls.html">nng_tls_dialer_dial(3tls)</a>, +<a href="nng_tls_free.3tls.html">nng_tls_free(3tls)</a>, +<a href="nng_tls_getopt.3tls.html">nng_tls_getopt(3tls)</a>, +<a href="nng_tls_listener_accept.3tls.html">nng_tls_listener_accept(3tls)</a>, +<a href="nng_tls_recv.3tls.html">nng_tls_recv(3tls)</a>, +<a href="nng_tls_send.3tls.html">nng_tls_send(3tls)</a>, +<a href="nng_tls_setopt.3tls.html">nng_tls_setopt(3tls)</a>, +<a href="nng_options.5.html">nng_options(5)</a>, +<a href="nng_tls_options.5.html">nng_tls_options(5)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> +</div> +<link rel="stylesheet" href="./pygments-default.css"> +</body> +</html>
\ No newline at end of file |