summaryrefslogtreecommitdiff
path: root/docs/man/nng_http_server_set_tls.adoc
blob: 50039e49474fcb216fec9804cb4b37fab89c172d (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
54
55
56
57
58
59
60
= nng_http_server_set_tls(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_http_server_set_tls - set HTTP server TLS configuration

== SYNOPSIS

[source, c]
-----------
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>

int nng_http_server_set_tls(nng_http_server *s, nng_tls_config *cfg);
-----------

== DESCRIPTION

The `nng_http_server_set_tls()` sets the TLS configuration of server _s_ to
_cfg_.

This change overwrites any previous TLS configuration.

WARNING: This also invalidates any previously obtained values from
<<nng_http_server_get_tls#,nng_http_server_get_tls(3)>>.

If the server is already running (i.e. it has been started with
<<nng_http_server_start#,nng_http_server_start(3)>>) then this will
fail with `NNG_EBUSY`.

TIP: Generally, the _cfg_ must have a configured private key, set with
<<nng_tls_config_own_cert#,nng_tls_config_own_cert(3)>> or similar.

== RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

== ERRORS

`NNG_EBUSY`:: Server instance is running.
`NNG_ENOMEM`:: Insufficient free memory exists.
`NNG_ENOTSUP`:: Either HTTP or TLS not supported.

== SEE ALSO

<<nng_http_server_get_tls#,nng_http_server_get_tls(3)>>,
<<nng_http_server_hold#,nng_http_server_hold(3)>>,
<<nng_http_server_start#,nng_http_server_start(3)>>,
<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
<<nng#,nng(7)>>