= nng_cv_alloc(3supp) // // Copyright 2018 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // 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 #include 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 <> or <>. The mutex must also be owned when signaling the condition using the <> or <> functions. == RETURN VALUES This function returns 0 on success, and non-zero otherwise. == ERRORS `NNG_ENOMEM`:: Insufficient free memory exists. == SEE ALSO <>, <>, <>, <>, <>, <>, <>, <>