summaryrefslogtreecommitdiff
path: root/docs/man/nng_thread_destroy.3supp.adoc
blob: b58c623b57d80eb23d22bf15d9b55099c89c2d3f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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)>>