diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-03-15 08:40:17 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-03-17 08:49:12 -0700 |
| commit | 98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch) | |
| tree | e3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_http_server_set_tls.adoc | |
| parent | 91866ed9365ab89069c12da41c873c23d0ba1d19 (diff) | |
| download | nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.gz nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.bz2 nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.zip | |
fixes #286 nng_pair0_open (and all others) need man page
fixes #279 consider restructuring man sections
This represents a rather significant rework, and major editing
effort, for the entire set of manual pages.
All of the pages now have a section number in their filename;
this assists in some other tooling, particularly ebook generation
as every link needs to be programmatically modified when combined
into an ebook.
Section 5 is introduced, and populated with pages for the main
types, and all options are now documented.
Numerous errors have been corrected, including rewriting certain
portions such as the header section of the surveyor protocol.
Much work has been done to facilitate index generation, although
certainly more work remains here.
Every internal link within these pages now resolves; there are no
more dead links. (This is required to generate Kindle format books.)
Diffstat (limited to 'docs/man/nng_http_server_set_tls.adoc')
| -rw-r--r-- | docs/man/nng_http_server_set_tls.adoc | 60 |
1 files changed, 0 insertions, 60 deletions
diff --git a/docs/man/nng_http_server_set_tls.adoc b/docs/man/nng_http_server_set_tls.adoc deleted file mode 100644 index 50039e49..00000000 --- a/docs/man/nng_http_server_set_tls.adoc +++ /dev/null @@ -1,60 +0,0 @@ -= 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)>> |
