diff options
Diffstat (limited to 'docs/man/nng_tls_config_server_name.adoc')
| -rw-r--r-- | docs/man/nng_tls_config_server_name.adoc | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/man/nng_tls_config_server_name.adoc b/docs/man/nng_tls_config_server_name.adoc deleted file mode 100644 index 8512d801..00000000 --- a/docs/man/nng_tls_config_server_name.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= nng_tls_config_server_name(3) -// -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> -// Copyright 2018 Capitar IT Group BV <info@capitar.com> -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_tls_config_server_name - configure remote server name - -== SYNOPSIS - -[source, c] ------------ -#include <nng/nng.h> -#include <nng/supplemental/tls/tls.h> - -int nng_tls_config_server_name(nni_tls_config *cfg, const char *name); ------------ - -== DESCRIPTION - -The `nng_tls_config_server_name()` function configures the remote server name -to be used by a client when connection to a server. The supplied _name_ -is used when comparing the identity in the server's certificate. Furthermore, -when Server Name Indication (SNI) is used, the _name_ may be sent to the server -as a hint to tell it which of several possible certificates should be used. - -TIP: This function is only useful in configuring client behavior. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_EBUSY`:: The configuration _cfg_ is already in use, and cannot be modified. - -== SEE ALSO - -<<nng_strerror#,nng_strerror(3)>>, -<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, -<<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>>, -<<nng#,nng(7)>> |