aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_tls_config_free.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2017-12-31 13:31:02 -0800
committerGarrett D'Amore <garrett@damore.org>2017-12-31 13:31:02 -0800
commit7df0165712bb6ca623830ac55c548696c83e8647 (patch)
tree397de6a93a7d638331b71d1c40c9b89b21487b39 /docs/nng_tls_config_free.adoc
parent772e16dd93d61d8cb9bce2d2e8b88ab42366f725 (diff)
downloadnng-7df0165712bb6ca623830ac55c548696c83e8647.tar.gz
nng-7df0165712bb6ca623830ac55c548696c83e8647.tar.bz2
nng-7df0165712bb6ca623830ac55c548696c83e8647.zip
Rename config init/fini to alloc/free, add documentation for them.
Diffstat (limited to 'docs/nng_tls_config_free.adoc')
-rw-r--r--docs/nng_tls_config_free.adoc61
1 files changed, 61 insertions, 0 deletions
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. <info@staysail.tech> \
+ 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 <nng/nng.h>
+
+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
+--------
+
+<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>
+<<nng#,nng(7)>>
+
+
+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].