From 98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 15 Mar 2018 08:40:17 -0700 Subject: 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.) --- docs/man/nng_tls_config_auth_mode.adoc | 71 ---------------------------------- 1 file changed, 71 deletions(-) delete mode 100644 docs/man/nng_tls_config_auth_mode.adoc (limited to 'docs/man/nng_tls_config_auth_mode.adoc') diff --git a/docs/man/nng_tls_config_auth_mode.adoc b/docs/man/nng_tls_config_auth_mode.adoc deleted file mode 100644 index af27cb5e..00000000 --- a/docs/man/nng_tls_config_auth_mode.adoc +++ /dev/null @@ -1,71 +0,0 @@ -= nng_tls_config_auth_mode(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_tls_config_auth_mode - configure authentication mode - -== SYNOPSIS - -[source, c] ------------ -#include -#include - -typedef enum nng_tls_auth_mode { - NNG_TLS_AUTH_MODE_NONE, - NNG_TLS_AUTH_MODE_OPTIONAL, - NNG_TLS_AUTH_MODE_REQUIRED -} nng_tls_auth_mode; - -int nng_tls_config_auth_mode(nni_tls_config *cfg, nng_tls_auth_mode mode); ------------ - -== DESCRIPTION - -The `nng_tls_config_auth_mode()` function configures the authentication mode -to be used for TLS sessions using this configuration object. - -The possible modes are: - -`NNG_TLS_AUTH_MODE_NONE`:: -No authentication of the TLS peer is performed. This is the default for -TLS servers, which most typically do not authenticate their clients. - -`NNG_TLS_AUTH_MODE_OPTIONAL`:: -If a certificate is presented by the peer, then it is validated. However, -if the peer does not present a valid certificate, then the sesssion is allowed -to proceed without authentication. - -`NNG_TLS_AUTH_MODE_REQUIRED`:: -A check is made to ensure that the peer has presented a valid certificate -used for the session. If the peer's certificate is invalid or missing, then -the session is refused. This is the default for clients. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_EINVAL`:: An invalid _mode_ was specified. -`NNG_EBUSY`:: The configuration _cfg_ is already in use, and cannot be modified. - - -== SEE ALSO - -<>, -<>, -<>, -<>, -<>, -<> -- cgit v1.2.3-70-g09d2