diff options
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/migrate/nng1.md | 17 | ||||
| -rw-r--r-- | docs/ref/xref.md | 8 |
2 files changed, 20 insertions, 5 deletions
diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md index d98b79f0..7a6698d0 100644 --- a/docs/ref/migrate/nng1.md +++ b/docs/ref/migrate/nng1.md @@ -33,14 +33,21 @@ The `NNG_OPT_WSS_REQUEST_HEADERS` and `NNG_OPT_WSS_RESPONSE_HEADERS` aliases for Just convert any use of them to `NNG_OPT_WS_REQUEST_HEADERS` or `NNG_OPT_WS_RESPONSE_HEADERS` as appropriate. -## TLS Options +## TLS Configuration -The support for configuring TLS via `NNG_TLS_AUTH_MODE`, `NNG_OPT_TLS_CA_FILE`, `NNG_OPT_TLS_SERVER_NAME`, -and similar has been removed. Instead configuration must be performed by allocating +The support for configuring TLS via `NNG_OPT_TLS_CONFIG`, `NNG_TLS_AUTH_MODE`, `NNG_OPT_TLS_CA_FILE`, +`NNG_OPT_TLS_SERVER_NAME`, and similar has been removed. + +Instead configuration must be performed by allocating a `nng_tls_config` object, and then setting fields on it using the appropriate functions, -after which it may be configured on a listener or dialer using the `NNG_OPT_TLS_CONFIG` option. +after which it may be configured on a listener or dialer using the [`nng_listener_set_tls`] +or [`nng_dialer_set_tls`] functions. + +Likewise, when using the streams API, use the [`nng_stream_listener_set_tls`] or +[`nng_stream_dialer_set_tls`] functions. -Note that TLS configuration is now available in `<nng/nng.h>`, rather than the supplemental header. +Note that the declarations needed for TLS configuration are now available in `<nng/nng.h>`, +rather than the supplemental header. ## Option Functions diff --git a/docs/ref/xref.md b/docs/ref/xref.md index 30714dc6..1139fa87 100644 --- a/docs/ref/xref.md +++ b/docs/ref/xref.md @@ -78,6 +78,14 @@ [`nng_sub0_ctx_unsubscribe`]: /TODO.md [`nng_sub0_socket_subscribe`]: /TODO.md [`nng_sub0_socket_unsubscribe`]: /TODO.md +[`nng_dialer_set_tls`]: /TODO.md +[`nng_dialer_get_tls`]: /TODO.md +[`nng_listener_set_tls`]: /TODO.md +[`nng_listener_get_tls`]: /TODO.md +[`nng_stream_dialer_set_tls`]: /TODO.md +[`nng_stream_dialer_get_tls`]: /TODO.md +[`nng_stream_listener_set_tls`]: /TODO.md +[`nng_stream_listener_get_tls`]: /TODO.md [`nng_opts_parse`]: /api/cmd_opts.md#parse-command-line-options [`nng_aio_begin`]: /TODO.md [`nng_aio_defer`]: /TODO.md |