aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_thread_destroy.3supp.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-22 14:06:07 -0700
committerGarrett D'Amore <garrett@damore.org>2018-03-22 14:06:07 -0700
commit53d5c2766d90a53d3f6c0437bc59c1ad63ec701a (patch)
treebc622efccbfaf9b05eca1c6c7ff8203011660651 /docs/man/nng_thread_destroy.3supp.adoc
parent1dc090d39eded06eee7725bd507599d8f59a3379 (diff)
downloadnng-53d5c2766d90a53d3f6c0437bc59c1ad63ec701a.tar.gz
nng-53d5c2766d90a53d3f6c0437bc59c1ad63ec701a.tar.bz2
nng-53d5c2766d90a53d3f6c0437bc59c1ad63ec701a.zip
Add documentation for supplemental functions.
This includes platform portability stuff like mutexes and threads, etc. While here we fixed a problem with nng_opts_parse and we addressed the type of the platform API.
Diffstat (limited to 'docs/man/nng_thread_destroy.3supp.adoc')
-rw-r--r--docs/man/nng_thread_destroy.3supp.adoc46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/man/nng_thread_destroy.3supp.adoc b/docs/man/nng_thread_destroy.3supp.adoc
new file mode 100644
index 00000000..b58c623b
--- /dev/null
+++ b/docs/man/nng_thread_destroy.3supp.adoc
@@ -0,0 +1,46 @@
+= nng_thread_destroy(3supp)
+//
+// 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_thread_destroy - reap thread
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+#include <nng/supplemental/util/platform.h>
+
+void nng_thread_destroy(nng_thread *thread);
+----
+
+== DESCRIPTION
+
+The `nng_thread_destroy()` function reaps the _thread_.
+It waits for the thread function to return, and then deallocates
+the resources for the thread.
+
+IMPORTANT: Do not call this function from the thread function itself,
+or a deadlock will occur.
+
+== RETURN VALUES
+
+None.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+<<nng_thread_create.3supp#,nng_thread_create(3supp)>>,
+<<nng.7#,nng(7)>>