summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/tip/nng_tcp.html8
-rw-r--r--man/tip/nng_tls.html8
-rw-r--r--man/tip/nng_ws.html8
-rw-r--r--man/tip/nng_zerotier.html78
-rw-r--r--man/tip/nngcat.html12
5 files changed, 63 insertions, 51 deletions
diff --git a/man/tip/nng_tcp.html b/man/tip/nng_tcp.html
index b44311fe..4127e7aa 100644
--- a/man/tip/nng_tcp.html
+++ b/man/tip/nng_tcp.html
@@ -625,16 +625,16 @@ These are <code>struct</code> types with the following definitions:</p>
<span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-p">{</span>
<span class="tok-c1">// ... </span><i class="conum" data-value="2"></i><b>(2)</b>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET</span>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</span>
<span class="tok-kt">uint32_t</span> <span class="tok-n">sa_addr</span><span class="tok-p">;</span>
<span class="tok-c1">// ...</span>
<span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_in</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-c1">// ... </span><i class="conum" data-value="2"></i><b>(2)</b>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET6</span>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET6</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</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-c1">// ...</span>
<span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_in6</span><span class="tok-p">;</span></code></pre>
diff --git a/man/tip/nng_tls.html b/man/tip/nng_tls.html
index 94bc3f92..daa0c3b7 100644
--- a/man/tip/nng_tls.html
+++ b/man/tip/nng_tls.html
@@ -688,16 +688,16 @@ These are <code>struct</code> types with the following definitions:</p>
<span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-p">{</span>
<span class="tok-c1">// ... </span><i class="conum" data-value="2"></i><b>(2)</b>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET</span>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</span>
<span class="tok-kt">uint32_t</span> <span class="tok-n">sa_addr</span><span class="tok-p">;</span>
<span class="tok-c1">// ...</span>
<span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_in</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-c1">// ... </span><i class="conum" data-value="2"></i><b>(2)</b>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET6</span>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET6</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</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-c1">// ...</span>
<span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_in6</span><span class="tok-p">;</span></code></pre>
diff --git a/man/tip/nng_ws.html b/man/tip/nng_ws.html
index 46695cfc..f35fe386 100644
--- a/man/tip/nng_ws.html
+++ b/man/tip/nng_ws.html
@@ -644,16 +644,16 @@ These are <code>struct</code> types with the following definitions:</p>
<span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-p">{</span>
<span class="tok-c1">// ... </span><i class="conum" data-value="2"></i><b>(2)</b>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET</span>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</span>
<span class="tok-kt">uint32_t</span> <span class="tok-n">sa_addr</span><span class="tok-p">;</span>
<span class="tok-c1">// ...</span>
<span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_in</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-c1">// ... </span><i class="conum" data-value="2"></i><b>(2)</b>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET6</span>
- <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_family</span><span class="tok-p">;</span> <span class="tok-c1">// must be NNG_AF_INET6</span>
+ <span class="tok-kt">uint16_t</span> <span class="tok-n">sa_port</span><span class="tok-p">;</span> <span class="tok-c1">// TCP port number</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-c1">// ...</span>
<span class="tok-p">}</span> <span class="tok-n">nng_sockaddr_in6</span><span class="tok-p">;</span></code></pre>
diff --git a/man/tip/nng_zerotier.html b/man/tip/nng_zerotier.html
index d5eeb948..07b215e3 100644
--- a/man/tip/nng_zerotier.html
+++ b/man/tip/nng_zerotier.html
@@ -514,6 +514,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<li><a href="#_uri_format">URI Format</a></li>
<li><a href="#_socket_address">Socket Address</a></li>
<li><a href="#_node_presence">Node Presence</a></li>
+<li><a href="#_network_status">Network Status</a></li>
<li><a href="#_transport_options">Transport Options</a></li>
</ul>
</li>
@@ -698,6 +699,49 @@ using the same node, or using separate nodes.</p>
</div>
</div>
<div class="sect2">
+<h3 id="_network_status">Network Status</h3>
+<div class="paragraph">
+<p>A ZeroTier node can be in one of the following states, which
+can be obtained with the <code>NNG_OPT_ZT_NETWORK_STATUS</code> option:</p>
+</div>
+<div class="dlist">
+<dl>
+<dt class="hdlist1"><code>NNG_ZT_STATUS_UP</code></dt>
+<dd>
+<p>The ZeroTier network is up. This is the only state where it is
+possible to communicate with peers, and the only state where
+the network name (<code>NNG_OPT_ZT_NETWORK_NAME</code>) is available.</p>
+</dd>
+<dt class="hdlist1"><code>NNG_ZT_STATUS_CONFIG</code></dt>
+<dd>
+<p>The ZeroTier node is still configuring, network services are not available.</p>
+</dd>
+<dt class="hdlist1"><code>NNG_ZT_STATUS_DENIED</code></dt>
+<dd>
+<p>The node does not have permission to join the ZeroTier network.</p>
+</dd>
+<dt class="hdlist1"><code>NNG_ZT_STATUS_NOTFOUND</code></dt>
+<dd>
+<p>The ZeroTier network is not found.</p>
+</dd>
+<dt class="hdlist1"><code>NNG_ZT_STATUS_ERROR</code></dt>
+<dd>
+<p>Some other ZeroTier error has occurred; the network is not available.</p>
+</dd>
+<dt class="hdlist1"><code>NNG_ZT_STATUS_OBSOLETE</code></dt>
+<dd>
+<p>The node is running obsolete software; the network is not available.</p>
+</dd>
+<dt class="hdlist1"><code>NNG_ZT_STATUS_UNKNOWN</code></dt>
+<dd>
+<p>The network is in an unknown state. This should not happen, as it
+indicates that the ZeroTier software is reporting an unexpected status.
+The network is most likely not available.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="sect2">
<h3 id="_transport_options">Transport Options</h3>
<div class="paragraph">
<p>The following transport options are available:</p>
@@ -743,39 +787,7 @@ provides a <code>uint64_t</code> in native byte order representing the ZeroTier
<dt class="hdlist1"><code>NNG_OPT_ZT_NETWORK_STATUS</code></dt>
<dd>
<p>This is a read-only integer, representing the ZeroTier network status.
-Valid values for this are:</p>
-<table class="tableblock frame-all grid-all spread">
-<colgroup>
-<col style="width: 37.5%;">
-<col style="width: 62.5%;">
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>nng_zt_network_status_configuring</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The ZeroTier node is still configuring, network services are not available.</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>nng_zt_network_status_ok</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The ZeroTier network is up.</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>nng_zt_network_status_denied</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The node does not have permission to join the ZeroTier network.</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>nng_zt_network_status_notfound</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The ZeroTier network is not found.</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>nng_zt_network_status_error</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Some other ZeroTier error has occurred; the network is not available.</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>nng_zt_network_status_obsolete</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The node is running obsolete software; the network is not available.</p></td>
-</tr>
-</tbody>
-</table>
+See <a href="#_network_status">Network Status</a> for an explanation of this option.</p>
</dd>
<dt class="hdlist1"><code>NNG_OPT_ZT_NETWORK_NAME</code></dt>
<dd>
diff --git a/man/tip/nngcat.html b/man/tip/nngcat.html
index 08bf4442..bdaaa33e 100644
--- a/man/tip/nngcat.html
+++ b/man/tip/nngcat.html
@@ -511,9 +511,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<li><a href="#_description">DESCRIPTION</a></li>
<li><a href="#_options">OPTIONS</a>
<ul class="sectlevel2">
-<li><a href="#_generic">Generic</a></li>
-<li><a href="#_protocol_selection">Protocol Selection</a></li>
-<li><a href="#_peer_selection">Peer Selection</a></li>
+<li><a href="#_generic_options">Generic Options</a></li>
+<li><a href="#_protocol_selection_options">Protocol Selection Options</a></li>
+<li><a href="#_peer_selection_options">Peer Selection Options</a></li>
<li><a href="#_receive_options">Receive Options</a></li>
<li><a href="#_transmit_options">Transmit Options</a></li>
<li><a href="#_tls_options">TLS Options</a></li>
@@ -594,7 +594,7 @@ the value (e.g. <code>-L5678</code>) or provided as the next program argument
each option must be presented as a separate argument to the program.</p>
</div>
<div class="sect2">
-<h3 id="_generic">Generic</h3>
+<h3 id="_generic_options">Generic Options</h3>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>-h, --help</strong></dt>
@@ -633,7 +633,7 @@ not specified at all, then a default subscription to everything is assumed.</p>
</div>
</div>
<div class="sect2">
-<h3 id="_protocol_selection">Protocol Selection</h3>
+<h3 id="_protocol_selection_options">Protocol Selection Options</h3>
<div class="admonitionblock note">
<table>
<tr>
@@ -721,7 +721,7 @@ version 0 peers, and can send a reply to them.</p>
</div>
</div>
<div class="sect2">
-<h3 id="_peer_selection">Peer Selection</h3>
+<h3 id="_peer_selection_options">Peer Selection Options</h3>
<div class="admonitionblock note">
<table>
<tr>
generated by cgit v1.2.3-70-g09d2 (git 2.46.0) at 2026-01-26 18:39:26 +0000