aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_server_set_tls.3http.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/nng_http_server_set_tls.3http.adoc')
-rw-r--r--docs/man/nng_http_server_set_tls.3http.adoc60
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/man/nng_http_server_set_tls.3http.adoc b/docs/man/nng_http_server_set_tls.3http.adoc
new file mode 100644
index 00000000..2b200653
--- /dev/null
+++ b/docs/man/nng_http_server_set_tls.3http.adoc
@@ -0,0 +1,60 @@
+= nng_http_server_set_tls(3http)
+//
+// 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.
+
+IMPORTANT: This also invalidates any previously obtained values from
+<<nng_http_server_get_tls.3http#,`nng_http_server_get_tls()`>>.
+
+If the server is already running (i.e. it has been started with
+<<nng_http_server_start.3http#,`nng_http_server_start()`>>) then this will
+fail with `NNG_EBUSY`.
+
+TIP: Generally, the _cfg_ must have a configured private key, set with
+<<nng_tls_config_own_cert.3tls#,`nng_tls_config_own_cert()`>> 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.3http#,nng_http_server_get_tls(3http)>>,
+<<nng_http_server_hold.3http#,nng_http_server_hold(3http)>>,
+<<nng_http_server_start.3http#,nng_http_server_start(3http)>>,
+<<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>,
+<<nng_strerror.3#,nng_strerror(3)>>,
+<<nng.7#,nng(7)>>