diff options
| author | Garrett D'Amore <garrett@damore.org> | 2025-01-02 00:20:28 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2025-01-02 00:20:28 -0800 |
| commit | 2f6c090c92a563f1a92329810675fb49f3105cc3 (patch) | |
| tree | 6988e0d257d08990f68e501b38812be88325aca1 /docs/ref | |
| parent | c0b1557c7931b63435f9d340f5a290556a3cc59c (diff) | |
| download | nng-2f6c090c92a563f1a92329810675fb49f3105cc3.tar.gz nng-2f6c090c92a563f1a92329810675fb49f3105cc3.tar.bz2 nng-2f6c090c92a563f1a92329810675fb49f3105cc3.zip | |
docs: document NNG_OPT_MAXTTL, other cleanups
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/api/sock.md | 19 | ||||
| -rw-r--r-- | docs/ref/xref.md | 10 |
2 files changed, 13 insertions, 16 deletions
diff --git a/docs/ref/api/sock.md b/docs/ref/api/sock.md index 0fef92e0..ea1eac0a 100644 --- a/docs/ref/api/sock.md +++ b/docs/ref/api/sock.md @@ -302,15 +302,16 @@ are available, whether they can be read or written, and the appropriate type to The following options are available for many protocols, and always use the same types and semantics described below. -| Option | Type | Description | -| --------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `NNG_OPT_RECONNMAXT` | `nng_duration` | Maximum time [dialers][dialer] will delay before trying after failing to connect. | -| `NNG_OPT_RECONNMINT` | `nng_duration` | Minimum time [dialers][dialer] will delay before trying after failing to connect. | -| `NNG_OPT_RECVBUF`<a name="NNG_OPT_RECVBUF"></a> | `int` | Maximum number of messages to buffer locally when receiving. | -| `NNG_OPT_RECVMAXSZ`<a name="NNG_OPT_RECVMAXSZ"></a> | `size_t` | Maximum message size acceptable for receiving. Can be tuned independently on [dialers][dialer] and [listeners][listener]. | -| `NNG_OPT_RECVTIMEO`<a name="NNG_OPT_RECVTIMEO"></a> | `nng_duration` | Default timeout (ms) for receiving messages. | -| `NNG_OPT_SENDBUF`<a name="NNG_OPT_SENDBUF"></a> | `int` | Maximum number of messages to buffer when sending messages. | -| `NNG_OPT_SENDTIMEO`<a name="NNG_OPT_SENDTIMEO"></a> | `nng_duration` | Default timeout (ms) for sending messages. | +| Option | Type | Description | +| ----------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `NNG_OPT_MAXTTL`<a name="NNG_OPT_MAXTTL"></a> | `int` | Maximum number of traversals across an [`nng_device`] device. | +| `NNG_OPT_RECONNMAXT`<a name="NNG_OPT_RECONNMAXT"></a> | `nng_duration` | Maximum time [dialers][dialer] will delay before trying after failing to connect. | +| `NNG_OPT_RECONNMINT`<a name="NNG_OPT_RECONNMINT"></a> | `nng_duration` | Minimum time [dialers][dialer] will delay before trying after failing to connect. | +| `NNG_OPT_RECVBUF`<a name="NNG_OPT_RECVBUF"></a> | `int` | Maximum number of messages to buffer locally when receiving. | +| `NNG_OPT_RECVMAXSZ`<a name="NNG_OPT_RECVMAXSZ"></a> | `size_t` | Maximum message size acceptable for receiving. Can be tuned independently on [dialers][dialer] and [listeners][listener]. | +| `NNG_OPT_RECVTIMEO`<a name="NNG_OPT_RECVTIMEO"></a> | `nng_duration` | Default timeout (ms) for receiving messages. | +| `NNG_OPT_SENDBUF`<a name="NNG_OPT_SENDBUF"></a> | `int` | Maximum number of messages to buffer when sending messages. | +| `NNG_OPT_SENDTIMEO`<a name="NNG_OPT_SENDTIMEO"></a> | `nng_duration` | Default timeout (ms) for sending messages. | diff --git a/docs/ref/xref.md b/docs/ref/xref.md index cfc9cbc3..f8d35fbb 100644 --- a/docs/ref/xref.md +++ b/docs/ref/xref.md @@ -198,10 +198,6 @@ [`nng_dialer_get_tls`]: /TODO.md [`nng_listener_set_tls`]: /TODO.md [`nng_listener_get_tls`]: /TODO.md -[`nng_stream_dialer_set_tls`]: /TODO.md -[`nng_stream_dialer_get_tls`]: /TODO.md -[`nng_stream_listener_set_tls`]: /TODO.md -[`nng_stream_listener_get_tls`]: /TODO.md [`nng_opts_parse`]: /api/cmd_opts.md#parse-command-line-options [`nng_aio_finish`]: /TODO.md [`nng_aio_reset`]: /TODO.md @@ -302,9 +298,9 @@ [`NNG_UNIT_EVENTS`]: /api/stats.md#statistic-units [`NNG_FLAG_NONBLOCK`]: /TODO.md [`NNG_OPT_LISTEN_FD`]: /api/streams.md#socket-activation -[`NNG_OPT_MAXTTL`]: /TODO.md -[`NNG_OPT_RECONNMAXT`]: /TODO.md -[`NNG_OPT_RECONNMINT`]: /TODO.md +[`NNG_OPT_MAXTTL`]: /api/sock.md#NNG_OPT_MAXTTL +[`NNG_OPT_RECONNMAXT`]: /api/sock.md#NNG_OPT_RECONNMAXT +[`NNG_OPT_RECONNMINT`]: /api/sock.md#NNG_OPT_RECONNMINT [`NNG_OPT_SENDTIMEO`]: /api/sock.md#NNG_OPT_SENDTIMEO [`NNG_OPT_RECVTIMEO`]: /api/sock.md#NNG_OPT_RECVTIMEO [`NNG_OPT_SENDBUF`]: /api/sock.md#NNG_OPT_SENDBUF |