aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_server_get_tls.adoc
blob: 0ad08f1101b49e535fb7cddfc69385415020458b (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
= nng_http_server_get_tls(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_http_server_get_tls - get HTTP server TLS configuration

== SYNOPSIS

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

int nng_http_server_get_tls(nng_http_server *s, nng_tls_config **cfgp);
-----------


== DESCRIPTION

The `nng_http_server_get_tls()` obtains the TLS configuration of server _s_ and
saves a pointer to it in the address referenced by _cfgp_.

The configuration will be `NULL` if the HTTP server instance is not enabled
to use HTTPS.

== RETURN VALUES

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

== ERRORS

`NNG_ENOMEM`:: Insufficient free memory exists.
`NNG_ENOTSUP`:: Either HTTP or TLS not supported.

== SEE ALSO

<<nng_http_server_hold#,nng_http_server_hold(3)>>,
<<nng_http_server_set_tls#,nng_http_server_set_tls(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)>>

== COPYRIGHT

{copyright}