diff options
| author | gdamore <gdamore@users.noreply.github.com> | 2025-10-09 01:22:20 +0000 |
|---|---|---|
| committer | gdamore <gdamore@users.noreply.github.com> | 2025-10-09 01:22:20 +0000 |
| commit | edd3b6bc34f211bd3d58642d0c69ce1b5bb9dc3b (patch) | |
| tree | f3396cdaec643fb87365b5f92df4f92e6644b075 /ref/tran/udp.html | |
| parent | ecdd21b5f4bd29bc1a88d276a9c8015dd100063b (diff) | |
| download | nng-edd3b6bc34f211bd3d58642d0c69ce1b5bb9dc3b.tar.gz nng-edd3b6bc34f211bd3d58642d0c69ce1b5bb9dc3b.tar.bz2 nng-edd3b6bc34f211bd3d58642d0c69ce1b5bb9dc3b.zip | |
deploy: 9c834956456924df7c885ab8b79573721acaff5c
Diffstat (limited to 'ref/tran/udp.html')
| -rw-r--r-- | ref/tran/udp.html | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/ref/tran/udp.html b/ref/tran/udp.html index 92674ff8..fc474ed1 100644 --- a/ref/tran/udp.html +++ b/ref/tran/udp.html @@ -301,19 +301,19 @@ and could be used to listen to port 9999 on the host:</p> <li><code>udp://:9999</code></li> </ol> <h2 id="socket-address"><a class="header" href="#socket-address">Socket Address</a></h2> -<p>When using an <a href="../../TODO.html"><code>nng_sockaddr</code></a> structure, +<p>When using an <a href="../TODO.html"><code>nng_sockaddr</code></a> structure, the actual structure is either of type -<a href="../../TODO.html"><code>nng_sockaddr_in</code></a> (for IPv4) or -<a href="../../TODO.html"><code>nng_sockaddr_in6</code></a> (for IPv6).</p> +<a href="../TODO.html"><code>nng_sockaddr_in</code></a> (for IPv4) or +<a href="../TODO.html"><code>nng_sockaddr_in6</code></a> (for IPv6).</p> <h2 id="transport-options"><a class="header" href="#transport-options">Transport Options</a></h2> <p>The following transport options are supported by this transport, where supported by the underlying platform.</p> <div class="table-wrapper"><table><thead><tr><th>Option</th><th>Type</th><th>Description</th></tr></thead><tbody> -<tr><td><a href="../../api/sock.html#NNG_OPT_LOCADDR"><code>NNG_OPT_LOCADDR</code></a></td><td><a href="../../TODO.html"><code>nng_sockaddr</code></a></td><td>The locally bound address, will be either <a href="../../TODO.html"><code>nng_sockaddr_in</code></a> or <a href="../../TODO.html"><code>nng_sockaddr_in6</code></a>.</td></tr> -<tr><td><a href="../../api/sock.html#NNG_OPT_REMADDR"><code>NNG_OPT_REMADDR</code></a></td><td><a href="../../TODO.html"><code>nng_sockaddr</code></a></td><td>The remote peer address, will be either <a href="../../TODO.html"><code>nng_sockaddr_in</code></a> or <a href="../../TODO.html"><code>nng_sockaddr_in6</code></a>. Only valid for <a href="../../api/pipe.html">pipe</a> and <a href="../../TODO.html">dialer</a> objects.</td></tr> -<tr><td><a href="../../api/sock.html#NNG_OPT_RECVMAXSZ"><code>NNG_OPT_RECVMAXSZ</code></a></td><td><code>size_t</code></td><td>Maximum size of incoming messages, will be limited to at most 65000.</td></tr> +<tr><td><a href="../api/sock.html#NNG_OPT_LOCADDR"><code>NNG_OPT_LOCADDR</code></a></td><td><a href="../TODO.html"><code>nng_sockaddr</code></a></td><td>The locally bound address, will be either <a href="../TODO.html"><code>nng_sockaddr_in</code></a> or <a href="../TODO.html"><code>nng_sockaddr_in6</code></a>.</td></tr> +<tr><td><a href="../api/sock.html#NNG_OPT_REMADDR"><code>NNG_OPT_REMADDR</code></a></td><td><a href="../TODO.html"><code>nng_sockaddr</code></a></td><td>The remote peer address, will be either <a href="../TODO.html"><code>nng_sockaddr_in</code></a> or <a href="../TODO.html"><code>nng_sockaddr_in6</code></a>. Only valid for <a href="../api/pipe.html">pipe</a> and <a href="../TODO.html">dialer</a> objects.</td></tr> +<tr><td><a href="../api/sock.html#NNG_OPT_RECVMAXSZ"><code>NNG_OPT_RECVMAXSZ</code></a></td><td><code>size_t</code></td><td>Maximum size of incoming messages, will be limited to at most 65000.</td></tr> <tr><td><code>NNG_OPT_UDP_COPY_MAX</code><a name="NNG_OPT_UDP_COPY_MAX"></a></td><td><code>size_t</code></td><td>Threshold above which received messages are “loaned” up, rather than a new message being allocated and copied into.</td></tr> -<tr><td><code>NNG_OPT_UDP_BOUND_PORT</code><a name="NNG_OPT_UDP_BOUND_PORT"></a></td><td><code>int</code></td><td>The locally bound UDP port number (1-65535), read-only for <a href="../../TODO.html">listener</a> objects only.</td></tr> +<tr><td><code>NNG_OPT_UDP_BOUND_PORT</code><a name="NNG_OPT_UDP_BOUND_PORT"></a></td><td><code>int</code></td><td>The locally bound UDP port number (1-65535), read-only for <a href="../TODO.html">listener</a> objects only.</td></tr> </tbody></table> </div> <h2 id="maximum-message-size"><a class="header" href="#maximum-message-size">Maximum Message Size</a></h2> @@ -334,7 +334,7 @@ the final user accessible payload will be 1140 bytes. Thus this can be likely be as a safe maximum to employ for SP payload data across all transports.</p> <p>The maximum message size is negotiated as part of establishing a peering relationship, and oversize messages will be dropped by the sender before going to the network.</p> -<p>The maximum message size to receive can be configured with the <a href="../../api/sock.html#NNG_OPT_RECVMAXSZ"><code>NNG_OPT_RECVMAXSZ</code></a> option.</p> +<p>The maximum message size to receive can be configured with the <a href="../api/sock.html#NNG_OPT_RECVMAXSZ"><code>NNG_OPT_RECVMAXSZ</code></a> option.</p> <h2 id="keep-alive"><a class="header" href="#keep-alive">Keep Alive</a></h2> <p>This transports maintains a logical “connection” with each peer, to provide a rough facsimile of a connection based semantic. This requires some resource on each peer. |
