aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_server_set_tls.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-06 16:07:10 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-06 16:07:10 -0800
commit51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9 (patch)
treef320ab2eec336cb781aa3774260e99a35d97e991 /docs/nng_http_server_set_tls.adoc
parent3b33f6878ee628da22fd4451f248c036aae231ed (diff)
downloadnng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.tar.gz
nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.tar.bz2
nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.zip
Document HTTP server API completely.
Diffstat (limited to 'docs/nng_http_server_set_tls.adoc')
-rw-r--r--docs/nng_http_server_set_tls.adoc64
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/nng_http_server_set_tls.adoc b/docs/nng_http_server_set_tls.adoc
new file mode 100644
index 00000000..5dda35ed
--- /dev/null
+++ b/docs/nng_http_server_set_tls.adoc
@@ -0,0 +1,64 @@
+= nng_http_server_set_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_set_tls - set HTTP server TLS configuration
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.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
+instance _s_.
+
+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)>>
+
+== COPYRIGHT
+
+{copyright}