diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-11-07 23:19:23 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-11-07 23:19:23 -0800 |
| commit | 89eb7d5c612bf80e223367e88f20d55d7fbea252 (patch) | |
| tree | 32743c182f2c54c4227e0187ce1a959b96843889 /docs/man/nng_tls_options.5.adoc | |
| parent | 7d90f9df0ad08733ac5211f88911a5c1ff747b19 (diff) | |
| download | nng-89eb7d5c612bf80e223367e88f20d55d7fbea252.tar.gz nng-89eb7d5c612bf80e223367e88f20d55d7fbea252.tar.bz2 nng-89eb7d5c612bf80e223367e88f20d55d7fbea252.zip | |
Document a number of things as deprecated.
This does not fully mark them in the headers, to avoid complicating
test suites and such, for now.
Diffstat (limited to 'docs/man/nng_tls_options.5.adoc')
| -rw-r--r-- | docs/man/nng_tls_options.5.adoc | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/man/nng_tls_options.5.adoc b/docs/man/nng_tls_options.5.adoc index a06a600f..0b346340 100644 --- a/docs/man/nng_tls_options.5.adoc +++ b/docs/man/nng_tls_options.5.adoc @@ -1,6 +1,6 @@ = nng_tls_options(5) // -// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2024 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // Copyright 2019 Devolutions <info@devolutions.net> // @@ -47,6 +47,13 @@ description of the option. === TLS Options +NOTE: Options for configuring TLS are deprecated and may +not be present in a future release. These options are +`NNG_OPT_TLS_AUTH_MODE`, `NNG_OPT_TLS_CA_FILE`, `NNG_OPT_TLS_CERT_KEY_FILE`, +and `NNG_OPT_TLS_SERVER_NAME`. Applications should switch to using the +`NNG_OPT_TLS_CONFIG` option and working with `nng_tls_config` objects. + + [[NNG_OPT_TLS_AUTH_MODE]]((`NNG_OPT_TLS_AUTH_MODE`)):: (`int`) Write-only option used to configure the authentication mode used. @@ -76,8 +83,6 @@ configuration object before returning it. NOTE: The caller should release the hold with xref:nng_tls_config_free.3tls.adoc[`nng_tls_config_free()`] when it no longer needs the TLS configuration object. -+ -TIP: Use this option when more advanced TLS configuration is required. [[NNG_OPT_TLS_SERVER_NAME]]((`NNG_OPT_TLS_SERVER_NAME`)):: (string) |