diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/nng_tcp_options.5.adoc | 8 | ||||
| -rw-r--r-- | docs/ref/migrate/nng1.md | 3 | ||||
| -rw-r--r-- | docs/ref/tran/udp.md | 12 |
3 files changed, 12 insertions, 11 deletions
diff --git a/docs/man/nng_tcp_options.5.adoc b/docs/man/nng_tcp_options.5.adoc index 37228b82..c6063d8a 100644 --- a/docs/man/nng_tcp_options.5.adoc +++ b/docs/man/nng_tcp_options.5.adoc @@ -22,7 +22,7 @@ nng_tcp_options - TCP-specific options #define NNG_OPT_TCP_NODELAY "tcp-nodelay" #define NNG_OPT_TCP_KEEPALIVE "tcp-keepalive" -#define NNG_OPT_TCP_BOUND_PORT "tcp-bound-port" +#define NNG_OPT_BOUND_PORT "bound-port" ---- == DESCRIPTION @@ -89,10 +89,10 @@ First, it can be used to detect dead peers on an otherwise quiescent network. Second, it can be used to keep connection table entries in NAT and other middleware from being expiring due to lack of activity. -[[NNG_OPT_TCP_BOUND_PORT]] -((`NNG_OPT_TCP_BOUND_PORT`)):: +[[NNG_OPT_BOUND_PORT]] +((`NNG_OPT_BOUND_PORT`)):: (`int`) -This option is available on listeners, after the listern has bound to +This option is available on listeners, after the listener has bound to a port, and provides the port bound to in native byte order. This is most useful when using a listener with an ephemeral port (configured by using port 0 at configuration time), as it allows diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md index df062efd..52b786cc 100644 --- a/docs/ref/migrate/nng1.md +++ b/docs/ref/migrate/nng1.md @@ -274,6 +274,9 @@ The latter option is a hint for transports and intended to facilitate early detection (and possibly avoidance of extra allocations) of oversize messages, before bringing them into the socket itself. +The `NNG_OPT_TCP_BOUND_PORT` port is renamed to just [`NNG_OPT_BOUND_PORT`], +and is available for listeners using transports based on either TCP or UDP. + ## Socket Options The `NNG_OPT_PROTO`, `NNG_OPT_PROTONAME`, `NNG_OPT_PEER`, and `NNG_OPT_PEERNAME` options diff --git a/docs/ref/tran/udp.md b/docs/ref/tran/udp.md index 0b83b542..920d5bcd 100644 --- a/docs/ref/tran/udp.md +++ b/docs/ref/tran/udp.md @@ -66,13 +66,11 @@ the actual structure is either of type The following transport options are supported by this transport, where supported by the underlying platform. -| Option | Type | Description | -| ------------------------------------------------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| [`NNG_OPT_LOCADDR`] | [`nng_sockaddr`] | The locally bound address, will be either [`nng_sockaddr_in`] or [`nng_sockaddr_in6`]. | -| [`NNG_OPT_REMADDR`] | [`nng_sockaddr`] | The remote peer address, will be either [`nng_sockaddr_in`] or [`nng_sockaddr_in6`]. Only valid for [pipe] and [dialer] objects. | -| [`NNG_OPT_RECVMAXSZ`] | `size_t` | Maximum size of incoming messages, will be limited to at most 65000. | -| `NNG_OPT_UDP_COPY_MAX`<a name="NNG_OPT_UDP_COPY_MAX"></a> | `size_t` | Threshold above which received messages are "loaned" up, rather than a new message being allocated and copied into. | -| `NNG_OPT_UDP_BOUND_PORT`<a name="NNG_OPT_UDP_BOUND_PORT"></a> | `int` | The locally bound UDP port number (1-65535), read-only for [listener] objects only. | +| Option | Type | Description | +| --------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------- | +| [`NNG_OPT_RECVMAXSZ`] | `size_t` | Maximum size of incoming messages, will be limited to at most 65000. | +| `NNG_OPT_UDP_COPY_MAX`<a name="NNG_OPT_UDP_COPY_MAX"></a> | `size_t` | Threshold above which received messages are "loaned" up, rather than a new message being allocated and copied into. | +| `NNG_OPT_BOUND_PORT`<a name="NNG_OPT_BOUND_PORT"></a> | `int` | The locally bound UDP port number (1-65535), read-only for [listener] objects only. | ## Maximum Message Size |