From 7df0165712bb6ca623830ac55c548696c83e8647 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 31 Dec 2017 13:31:02 -0800 Subject: Rename config init/fini to alloc/free, add documentation for them. --- docs/nng_tls_config_free.adoc | 61 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 docs/nng_tls_config_free.adoc (limited to 'docs/nng_tls_config_free.adoc') diff --git a/docs/nng_tls_config_free.adoc b/docs/nng_tls_config_free.adoc new file mode 100644 index 00000000..8e94e7f2 --- /dev/null +++ b/docs/nng_tls_config_free.adoc @@ -0,0 +1,61 @@ +nng_tls_config_alloc(3) +======================= +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:icons: font +:source-highlighter: pygments +:copyright: Copyright 2017 Staysail Systems, Inc. \ + This software 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_free - deallocate a TLS configuration object + +SYNOPSIS +-------- + +[source, c] +----------- +#include + +void nng_tls_config_free(nni_tls_config *cfg); +----------- + +DESCRIPTION +----------- + +The `nng_tls_config_free()` decrements the reference count on a +TLS configuration object, and if the resulting reference count is zero, +then deallocates the configuration object. + +RETURN VALUES +------------- + +None. + + +ERRORS +------ + +None. + + +SEE ALSO +-------- + +<> +<> + + +COPYRIGHT +--------- + +Copyright 2017 mailto:info@staysail.tech[Staysail Systems, Inc.] + +This document is supplied under the terms of the +https://opensource.org/licenses/LICENSE.txt[MIT License]. -- cgit v1.2.3-70-g09d2