aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_tls_config_alloc.3tls.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-11-05 17:21:34 -0800
committerGarrett D'Amore <garrett@damore.org>2018-11-05 18:09:35 -0800
commit3cc0bb37e3543052f336abe1d3349ff095f72ae2 (patch)
tree048163a5c66029c4837be4ac93a56f0790df8dc4 /docs/man/nng_tls_config_alloc.3tls.adoc
parent77984b14a65c0a7387c97f3d36f947dd17358744 (diff)
downloadnng-3cc0bb37e3543052f336abe1d3349ff095f72ae2.tar.gz
nng-3cc0bb37e3543052f336abe1d3349ff095f72ae2.tar.bz2
nng-3cc0bb37e3543052f336abe1d3349ff095f72ae2.zip
fixes #456 TLS configuration object hold
fixes #776 Configuration of mbedTLS should warn about license
Diffstat (limited to 'docs/man/nng_tls_config_alloc.3tls.adoc')
-rw-r--r--docs/man/nng_tls_config_alloc.3tls.adoc10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/man/nng_tls_config_alloc.3tls.adoc b/docs/man/nng_tls_config_alloc.3tls.adoc
index 92ed5d41..edbf1c1e 100644
--- a/docs/man/nng_tls_config_alloc.3tls.adoc
+++ b/docs/man/nng_tls_config_alloc.3tls.adoc
@@ -47,7 +47,14 @@ or services.
The underlying system uses reference counting to ensure
that object is not inadvertently freed while in use.
-Also note that a TLS configuration object becomes "read-only" after it
+A configuration object created with `nng_tls_config_alloc()` starts
+with a reference count of one.
+The reference count may be incremented using
+`<<nng_tls_config_hold.3tls#,nng_tls_config_hold()>>` and may be
+decremented with
+`<<nng_tls_config_free.3tls#,nng_tls_config_free()>>`.
+
+Also note that a TLS configuration object becomes "`read-only`" after it
is first used with a service.
After this points, attempts to apply
further changes to the configuration will result in `NNG_EBUSY`.
@@ -71,5 +78,6 @@ This function returns 0 on success, and non-zero otherwise.
<<nng_tls_config_ca_chain.3tls#,nng_tls_config_ca_chain(3tls)>>,
<<nng_tls_config_own_cert.3tls#,nng_tls_config_own_cert(3tls)>>,
<<nng_tls_config_free.3tls#,nng_tls_config_free(3tls)>>,
+<<nng_tls_config_hold.3tls#,nng_tls_config_hold(3tls)>>,
<<nng_tls_config_server_name.3tls#,nng_tls_config_server_name(3tls)>>,
<<nng.7#,nng(7)>>