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
47
48
49
50
51
52
53
54
55
56
57
58
|
= nng_cv_alloc(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_cv_alloc - allocate condition variable
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
#include <nng/supplemental/util/platform.h>
typedef struct nng_cv nng_cv;
int nng_cv_alloc(nng_cv **cvp, nng_mtx *mtx);
----
== DESCRIPTION
The `nng_cv_alloc()` function allocates a condition variable, using
the mutex _mtx_, and returns it in _cvp_.
Every condition variable is associated with a mutex, which must be
owned when a thread waits for the condition using
`<<nng_cv_wait.3supp#,nng_cv_wait()>>` or
`<<nng_cv_until.3supp#,nng_cv_until()>>`.
The mutex must also be owned when signaling the condition using the
`<<nng_cv_wake.3supp#,nng_cv_wake()>>` or
`<<nng_cv_wake1.3supp#,nng_cv_wake1()>>` functions.
== RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
== ERRORS
`NNG_ENOMEM`:: Insufficient free memory exists.
== SEE ALSO
<<nng_cv_free.3supp#,nng_cv_free(3supp)>>,
<<nng_cv_until.3supp#,nng_cv_until(3supp)>>,
<<nng_cv_wait.3supp#,nng_cv_wait(3supp)>>,
<<nng_cv_wake.3supp#,nng_cv_wake(3supp)>>,
<<nng_cv_wake1.3supp#,nng_cv_wake1(3supp)>>,
<<nng_mtx_alloc.3supp#,nng_mtx_alloc(3supp)>>,
<<nng_strerror.3#,nng_strerror(3)>>,
<<nng.7#,nng(7)>>
|
