diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_http_server_get_tls.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_http_server_get_tls.adoc')
| -rw-r--r-- | docs/nng_http_server_get_tls.adoc | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/nng_http_server_get_tls.adoc b/docs/nng_http_server_get_tls.adoc deleted file mode 100644 index c19fb4d9..00000000 --- a/docs/nng_http_server_get_tls.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= nng_http_server_get_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_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)>> |