diff options
| author | Garrett D'Amore <garrett@damore.org> | 2025-10-26 10:02:33 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2025-10-26 10:02:33 -0700 |
| commit | 72b96ad6925634e1b4efa775ffbed436b0a29abd (patch) | |
| tree | aca1508cbc9fa89597fae7e059263725983d6485 /docs/ref | |
| parent | e0cb4377cc4d6fe50514e0b297e174fdde001bb6 (diff) | |
| download | nng-72b96ad6925634e1b4efa775ffbed436b0a29abd.tar.gz nng-72b96ad6925634e1b4efa775ffbed436b0a29abd.tar.bz2 nng-72b96ad6925634e1b4efa775ffbed436b0a29abd.zip | |
NNG_OPT_BOUND_PORT replaces NNG_OPT_TCP/UDP_BOUND_PORT.
This is easier and agnostic about the underlying L3 protocol.
We plan to remove direct NNG_OPT_LOCADDR support from listeners
(and probably both NNG_OPT_LOCADDR and NNG_OPT_REMADDR have numbered
days left in their lifetime. They will be replaced with more direct
typed access functions as has been done for pipes already.)
While here fixed some include for IWYU in the POSIX platform.
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/migrate/nng1.md | 3 | ||||
| -rw-r--r-- | docs/ref/tran/udp.md | 12 |
2 files changed, 8 insertions, 7 deletions
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 |