diff options
| -rw-r--r-- | docs/man/nng_tcp.7.adoc | 8 | ||||
| -rw-r--r-- | docs/man/nng_tls.7.adoc | 8 | ||||
| -rw-r--r-- | docs/ref/api/sock.md | 20 | ||||
| -rw-r--r-- | docs/ref/tran/udp.md | 8 |
4 files changed, 19 insertions, 25 deletions
diff --git a/docs/man/nng_tcp.7.adoc b/docs/man/nng_tcp.7.adoc index a5855f77..cf84ac7e 100644 --- a/docs/man/nng_tcp.7.adoc +++ b/docs/man/nng_tcp.7.adoc @@ -55,14 +55,12 @@ be specified as `tcp://[::1]:80`. The special value of 0 (`INADDR_ANY`)(((`INADDR_ANY`))) can be used for a listener to indicate that it should listen on all interfaces on the host. -A short-hand for this form is to either omit the address, or specify -the asterisk (`*`) character. -For example, the following three URIs are all equivalent, +A short-hand for this form is to omit the IP address entirely. +For example, the following URIs are equivalent, and could be used to listen to port 9999 on the host: 1. `tcp://0.0.0.0:9999` - 2. `tcp://*:9999` - 3. `tcp://:9999` + 2. `tcp://:9999` The entire URI must be less than `NNG_MAXADDRLEN` bytes long. diff --git a/docs/man/nng_tls.7.adoc b/docs/man/nng_tls.7.adoc index a4b39f48..a6ad395c 100644 --- a/docs/man/nng_tls.7.adoc +++ b/docs/man/nng_tls.7.adoc @@ -80,14 +80,12 @@ the certificate supplied by the server. The special value of 0 (`INADDR_ANY`) can be used for a listener to indicate that it should listen on all interfaces on the host. -A short-hand for this form is to either omit the address, or specify -the asterisk (`*`) character. -For example, the following three URIs are all equivalent, +A short-hand for this form is to omit the IP address entirely. +For example, the following URIs are equivalent, and could be used to listen to port 9999 on the host: 1. `tls+tcp://0.0.0.0:9999` - 2. `tls+tcp://*:9999` - 3. `tls+tcp://:9999` + 2. `tls+tcp://:9999` The entire URI must be less than `NNG_MAXADDRLEN` bytes long. 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`<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. | +| Option | Type | Description | +| ----------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `NNG_OPT_MAXTTL`<a name="NNG_OPT_MAXTTL"></a> | `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`<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 (0-8192) to buffer locally when receiving. | +| `NNG_OPT_RECVMAXSZ`<a name="NNG_OPT_RECVMAXSZ"></a> | `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`<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 (0-8192) 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/tran/udp.md b/docs/ref/tran/udp.md index 91d9a988..7093ea3e 100644 --- a/docs/ref/tran/udp.md +++ b/docs/ref/tran/udp.md @@ -47,14 +47,12 @@ be specified as `udp://[::1]:8001`. The special value of 0 ({{i:`INADDR_ANY`}}) can be used for a listener to indicate that it should listen on all interfaces on the host. -A short-hand for this form is to either omit the address, or specify -the asterisk (`*`) character. -For example, the following three URIs are all equivalent, +A short-hand for this form is to omit the IP address entirely. +For example, the following two URIs are equivalent, and could be used to listen to port 9999 on the host: 1. `udp://0.0.0.0:9999` -2. `udp://*:9999` -3. `udp://:9999` +2. `udp://:9999` ## Socket Address |