diff options
Diffstat (limited to 'docs/man/nng_tls.7.adoc')
| -rw-r--r-- | docs/man/nng_tls.7.adoc | 51 |
1 files changed, 22 insertions, 29 deletions
diff --git a/docs/man/nng_tls.7.adoc b/docs/man/nng_tls.7.adoc index 59aa77f2..bb9eb614 100644 --- a/docs/man/nng_tls.7.adoc +++ b/docs/man/nng_tls.7.adoc @@ -119,66 +119,59 @@ The following transport options are available. Note that setting these must be done before the transport is started. ((`NNG_OPT_TCP_KEEPALIVE`)):: - -This option is used to configure TCP keep-alives. -The value is of type `bool`, and defaults to `false`. +(`bool`) Enable TCP keep-alives, defaults to `false`. ((`NNG_OPT_TCP_NODELAY`)):: - -This option is used to configure Nagle's algorithm. +(`bool`) Disable Nagle's algorithm. When enabled (`false`), the underlying TCP stream will attempt to buffer and coalesce messages before sending them on, waiting a short interval to improve buffering and reduce the overhead caused by sending too-small messages. This comes at a cost to latency, and is not recommended with modern high speed networks. -The value is of type `bool` and defaults to `true`. +Defaults to `true`. ((`NNG_OPT_TLS_CONFIG`)):: - -This option is used on an endpoint to access the underlying TLS +(`nng_tls_config *`) +The underlying TLS configuration object. -The value is of type `nng_tls_config *`. -If the value is not `NULL`, a hold is placed on the underlying -configuration object before returning it (see -`<<nng_tls_config_hold.3tls#,nng_tls_config_hold()>>`). -The caller should release the object with +A hold is placed on the underlying +configuration object before returning it. +The caller should release the hold with `<<nng_tls_config_free.3tls#,nng_tls_config_free()>>` when it no longer needs the TLS configuration object. 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 -associated private key from a file. +(string) Write-only option naming a file containing certificates to +use for peer validation. 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. (Use the `NNG_OPT_TLS_CONFIG` option to access the underlying +(string) Write-only option naming a file containing the local certificate and +associated private key. +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 information. ((`NNG_OPT_TLS_AUTH_MODE`)):: - -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`. +(`int`) Write-only option used to configure the authentication mode used. +Must be one of +`NNG_TLS_AUTH_MODE_NONE`, +`NNG_TLS_AUTH_MODE_REQUIRED`, or +`NNG_TLS_AUTH_MODE_OPTIONAL`. See `<<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode()>>` for more 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 -results if peer authentication is disabled with `NNG_TLS_AUTH_MODE_NONE`. +(`bool`) Whether the remote peer has been properly verified using TLS +authentication. +May return incorrect results if peer authentication is disabled. == SEE ALSO |