From 288c9bf6dfc333b5a4d894b24e54e4fb3da34d51 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 2 Jan 2025 00:40:06 -0800 Subject: docs: remove references to asterisk wildcard, other tweaks --- docs/ref/api/sock.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'docs/ref/api/sock.md') diff --git a/docs/ref/api/sock.md b/docs/ref/api/sock.md index ea1eac0a..61a88ab5 100644 --- a/docs/ref/api/sock.md +++ b/docs/ref/api/sock.md @@ -302,16 +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_MAXTTL` | `int` | Maximum number of traversals across an [`nng_device`] device. | -| `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` | `int` | Maximum number of messages to buffer locally when receiving. | -| `NNG_OPT_RECVMAXSZ` | `size_t` | Maximum message size acceptable for receiving. Can be tuned independently on [dialers][dialer] and [listeners][listener]. | -| `NNG_OPT_RECVTIMEO` | `nng_duration` | Default timeout (ms) for receiving messages. | -| `NNG_OPT_SENDBUF` | `int` | Maximum number of messages to buffer when sending messages. | -| `NNG_OPT_SENDTIMEO` | `nng_duration` | Default timeout (ms) for sending messages. | +| Option | Type | Description | +| ----------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `NNG_OPT_MAXTTL` | `int` | Maximum number of traversals across an [`nng_device`] device, to prevent forwarding loops. May be 1-255, inclusive. Normally defaults to 8. | +| `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` | `int` | Maximum number of messages (0-8192) to buffer locally when receiving. | +| `NNG_OPT_RECVMAXSZ` | `size_t` | Maximum message size acceptable for receiving. Zero means unlimited. Intended to prevent remote abuse. Can be tuned independently on [dialers][dialer] and [listeners][listener]. | +| `NNG_OPT_RECVTIMEO` | `nng_duration` | Default timeout (ms) for receiving messages. | +| `NNG_OPT_SENDBUF` | `int` | Maximum number of messages (0-8192) to buffer when sending messages. | +| `NNG_OPT_SENDTIMEO` | `nng_duration` | Default timeout (ms) for sending messages. |   -- cgit v1.2.3-70-g09d2