summaryrefslogtreecommitdiff
path: root/docs/nng_tls_config_server_name.adoc
blob: bbe017bb7b9854aa509120df4cd40a298cec1c8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
= nng_tls_config_server_name(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:manvolnum: 3
:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
            Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
            {blank} + \
            This document is supplied under the terms of the \
            https://opensource.org/licenses/MIT[MIT License].

== NAME

nng_tls_config_server_name - configure remote server name

== SYNOPSIS

[source, c]
-----------
#include <nng/nng.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)>>

== COPYRIGHT

{copyright}