diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/nng_dial.3.adoc | 2 | ||||
| -rw-r--r-- | docs/man/nng_http_handler_alloc.3http.adoc | 9 | ||||
| -rw-r--r-- | docs/man/nng_listen.3.adoc | 4 | ||||
| -rw-r--r-- | docs/man/nng_listener_start.3.adoc | 2 | ||||
| -rw-r--r-- | docs/man/nng_pair.7.adoc | 4 | ||||
| -rw-r--r-- | docs/man/nng_sleep_aio.3.adoc | 2 | ||||
| -rw-r--r-- | docs/man/nng_ws.7.adoc | 21 | ||||
| -rw-r--r-- | docs/man/nng_zerotier.7.adoc | 10 |
8 files changed, 28 insertions, 26 deletions
diff --git a/docs/man/nng_dial.3.adoc b/docs/man/nng_dial.3.adoc index c2044dfb..525f092a 100644 --- a/docs/man/nng_dial.3.adoc +++ b/docs/man/nng_dial.3.adoc @@ -39,7 +39,7 @@ When the pipe is closed, the dialer attempts to re-establish the connection. Dialers will also periodically retry a connection automatically if an attempt to connect asynchronously fails. -TIP: While it is convenient to think of dialers as "`clients``", the relationship +TIP: While it is convenient to think of dialers as "`clients`", the relationship between the listener or dialer is orthogonal to any server or client status that might be associated with a given protocol. For example, a <<nng_req.7#,_req_>> diff --git a/docs/man/nng_http_handler_alloc.3http.adoc b/docs/man/nng_http_handler_alloc.3http.adoc index e1238b8f..12c6043a 100644 --- a/docs/man/nng_http_handler_alloc.3http.adoc +++ b/docs/man/nng_http_handler_alloc.3http.adoc @@ -62,13 +62,13 @@ rather than just a single element. The generic (first) form of this creates a handler that uses a user-supplied function to process HTTP requests. This function uses the asynchronous I/O framework. -The function takes a pointer to an `nng_aio` structure. +The function takes a pointer to an <<nng_aio.5#,`nng_aio`>> structure. That structure will be passed with the following input values (retrieved with <<nng_aio_get_input.3#,`nng_aio_get_input()`>>): - 0: ``nng_http_req *`` __request__:: The client's HTTP request. - 1: ``nng_http_handler *``__handler__:: Pointer to the handler object. - 2: ``nng_http_conn *``__conn__:: The underlying HTTP connection. + 0: `nng_http_req *` __request__:: The client's HTTP request. + 1: `nng_http_handler *` __handler__:: Pointer to the handler object. + 2: `nng_http_conn *` __conn__:: The underlying HTTP connection. The handler should create an `nng_http_res *` response (such as via <<nng_http_res_alloc.3http#,`nng_http_res_alloc()`>> or @@ -146,4 +146,5 @@ This function returns 0 on success, and non-zero otherwise. <<nng_http_res_alloc_error.3http#,nng_http_res_alloc_error(3http)>>, <<nng_http_server_add_handler.3http#,nng_http_server_add_handler(3http)>>, <<nng_strerror.3#,nng_strerror(3)>>, +<<nng_aio.5#,nng_aio(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_listen.3.adoc b/docs/man/nng_listen.3.adoc index 60f98155..bc4222ab 100644 --- a/docs/man/nng_listen.3.adoc +++ b/docs/man/nng_listen.3.adoc @@ -36,14 +36,14 @@ An incoming connection generally results in and Unlike dialers, listeners generally can create many pipes, which may be open concurrently. -TIP: While it is convenient to think of listeners as "`servers``", the +TIP: While it is convenient to think of listeners as "`servers`", the relationship between the listener or dialer is orthogonal to any server or client status that might be associated with a given protocol. For example, a <<nng_req.7#,_req_>> socket might have associated dialers, but might also have associated listeners. It may even have some of each at the same time! -Normally, the act of "`binding``" to the address indicated by _url_ is done +Normally, the act of "`binding`" to the address indicated by _url_ is done synchronously, including any necessary name resolution. As a result, a failure, such as if the address is already in use, will be returned immediately. diff --git a/docs/man/nng_listener_start.3.adoc b/docs/man/nng_listener_start.3.adoc index 3edd8093..5938e784 100644 --- a/docs/man/nng_listener_start.3.adoc +++ b/docs/man/nng_listener_start.3.adoc @@ -32,7 +32,7 @@ dialers. Each new connection results in an <<nng_pipe.5#,`nng_pipe`>> object, which will be attached to the listener's socket. -Normally, the act of "`binding``" to it's address is done +Normally, the act of "`binding`" to it's address is done synchronously, including any necessary name resolution. As a result, a failure, such as if the address is already in use, will be returned diff --git a/docs/man/nng_pair.7.adoc b/docs/man/nng_pair.7.adoc index 35f71187..f0824555 100644 --- a/docs/man/nng_pair.7.adoc +++ b/docs/man/nng_pair.7.adoc @@ -105,13 +105,13 @@ The following protocol-specific options are available. ((`NNG_OPT_PAIR1_POLY`)):: - (Version 1 only). This option enables the use of _polyamorous_ mode. + (`bool`, version 1 only) This option enables the use of _polyamorous_ mode. The value is read-write, and takes an integer boolean value. The default false value (0) indicates that legacy monogamous mode should be used. <<nng_options.5#NNG_OPT_MAXTTL,`NNG_OPT_MAXTTL`>>:: - (Version 1 only). Maximum time-to-live. + (`int`, version 1 only). Maximum time-to-live. === Protocol Headers diff --git a/docs/man/nng_sleep_aio.3.adoc b/docs/man/nng_sleep_aio.3.adoc index f83a7549..280d0422 100644 --- a/docs/man/nng_sleep_aio.3.adoc +++ b/docs/man/nng_sleep_aio.3.adoc @@ -24,7 +24,7 @@ void nng_sleep_aio(nng_duration msec, nng_aio *aio); == DESCRIPTION -The `nng_sleep_aio()` function performs an asynchronous "`sleep``", +The `nng_sleep_aio()` function performs an asynchronous "`sleep`", causing the callback for _aio_ to be executed after _msec_ milliseconds. If the sleep finishes completely, the result will always be zero. diff --git a/docs/man/nng_ws.7.adoc b/docs/man/nng_ws.7.adoc index f3d59a63..d3b68b99 100644 --- a/docs/man/nng_ws.7.adoc +++ b/docs/man/nng_ws.7.adoc @@ -133,23 +133,24 @@ This option can be set on listeners, and retrieved from pipes. ((`NNG_OPT_TLS_CONFIG`)):: -This option is used on an endpoint to access the underlying TLS -configuration object. The value is of type `nng_tls_config *`. +(opaque) This option is used on an endpoint to access the underlying TLS +configuration object. +The value is of type `nng_tls_config *`. TIP: Use this option when advanced TLS configuration is required. ((`NNG_OPT_TLS_CA_FILE`)):: -This is a write-only option used to load certificates associated +(string) This is a write-only option used to load certificates associated associated private key from a file. See <<nng_tls_config_ca_file.3tls#,`nng_tls_config_ca_file()`>> for more information. ((`NNG_OPT_TLS_CERT_KEY_FILE`)):: -This is a write-only option used to load the local certificate and -associated private key from a file. The private key used must be -unencrypted. +(string) This is a write-only option used to load the local certificate and +associated private key from a file. +The private key used must be unencrypted. (Use the `NNG_OPT_TLS_CONFIG` option to access the underlying TLS configuration if more advanced configuration is needed.) See <<nng_tls_config_own_cert.3tls#,`nng_tls_config_own_cert()`>> for more @@ -157,7 +158,7 @@ information. ((`NNG_OPT_TLS_AUTH_MODE`)):: -This is a write-only option used to configure the authentication mode +(`int`) This is a write-only option used to configure the authentication mode used. It can take an integer with value `NNG_TLS_AUTH_MODE_NONE`, `NNG_TLS_AUTH_MODE_REQUIRED`, or `NNG_TLS_AUTH_MODE_OPTIONAL`. @@ -166,9 +167,9 @@ details. `NNG_OPT_TLS_VERIFIED`:: -This is a read-only option which returns a boolean value (integer 0 or 1). -It will true (1) if the remote peer has been properly verified using TLS -authentication, or false (0) otherwise. This option may return incorrect +(bool) This is a read-only option that is `true` if the remote peer has been +properly verified using TLS authentication, or `false` otherwise. +This option may return incorrect results if peer authentication is disabled with `NNG_TLS_AUTH_MODE_NONE`. // We should also look at a hook mechanism for listeners. Probably this could diff --git a/docs/man/nng_zerotier.7.adoc b/docs/man/nng_zerotier.7.adoc index 2e62edc9..c26f1f50 100644 --- a/docs/man/nng_zerotier.7.adoc +++ b/docs/man/nng_zerotier.7.adoc @@ -137,7 +137,7 @@ The network is most likely not available. The following transport options are available: ((`NNG_OPT_ZT_HOME`)):: - This is a string representing the "`home directory``", where the transport + This is a string representing the "`home directory`", where the transport can store (and reuse) persistent state, such as key materials, node identity, and federation membership. This option must be set before the ZeroTier transport is first used. @@ -191,12 +191,12 @@ in this fashion. [[NNG_OPT_ZT_PING_TIME]] ((`NNG_OPT_ZT_PING_TIME`)):: If no traffic has been received from the ZeroTier peer after this - period of time, then a "`ping``" message is sent to check if the peer + period of time, then a "`ping`" message is sent to check if the peer is still alive. This is an <<nng_duration.5#,`nng_duration`>> (msec). [[NNG_OPT_ZT_PING_TRIES]] ((`NNG_OPT_ZT_PING_TRIES`)):: - If this number (`int`) of consecutive "`ping``" requests are sent to the + If this number (`int`) of consecutive "`ping`" requests are sent to the peer with no response (and no other intervening traffic), then the peer is assumed to be dead and the connection is closed. Note that if any traffic is received from the peer, then the underlying counter @@ -213,14 +213,14 @@ in this fashion. [[NNG_OPT_ZT_ORBIT]] ((`NNG_OPT_ZT_ORBIT`))(((orbit, ZeroTier)))(((federation,ZeroTier))): This is a write-only option that takes an array of two `uint64_t` values, - indicating the ID of a ZeroTier "`moon``", and the node ID of the root server + indicating the ID of a ZeroTier "`moon`", and the node ID of the root server for that moon. (The ID may be zero if the moon ID is the same as it's root server ID, which is conventional.) [[NNG_OPT_ZT_DEORBIT]] ((`NNG_OPT_ZT_DEORBIT`)):: This write-only option takes a single `uint64_t` indicating the moon - ID to "`deorbit``". If the node is not already orbiting the moon, then + ID to "`deorbit`". If the node is not already orbiting the moon, then this has no effect. == SEE ALSO |