diff options
| author | Staysail Systems, Inc <info@staysail.tech> | 2020-08-02 12:14:46 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2020-08-02 12:16:42 -0700 |
| commit | c4050ecbf846d138a07bfaf238306fb862b9a3d5 (patch) | |
| tree | c7acd7020bb58336979064a919e332a985c42307 /man/v1.3.2/nng_cv_alloc.3supp.html | |
| parent | 37450b49a0b3a5f6a10d04ddd46560caf444fc67 (diff) | |
| download | nng-c4050ecbf846d138a07bfaf238306fb862b9a3d5.tar.gz nng-c4050ecbf846d138a07bfaf238306fb862b9a3d5.tar.bz2 nng-c4050ecbf846d138a07bfaf238306fb862b9a3d5.zip | |
Manual page updates for v1.3.2
Diffstat (limited to 'man/v1.3.2/nng_cv_alloc.3supp.html')
| -rw-r--r-- | man/v1.3.2/nng_cv_alloc.3supp.html | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/man/v1.3.2/nng_cv_alloc.3supp.html b/man/v1.3.2/nng_cv_alloc.3supp.html new file mode 100644 index 00000000..1a7fb820 --- /dev/null +++ b/man/v1.3.2/nng_cv_alloc.3supp.html @@ -0,0 +1,86 @@ +--- +version: v1.3.2 +layout: manpage_v2 +--- +<h1>nng_cv_alloc(3supp)</h1> +<div class="sect1"> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>nng_cv_alloc - allocate condition variable</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_synopsis">SYNOPSIS</h2> +<div class="sectionbody"> +<div class="listingblock"> +<div class="content"> +<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span><span class="tok-cp"> +</span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/util/platform.h></span><span class="tok-cp"> +</span><span class="tok-cp"></span> +<span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_cv</span> <span class="tok-n">nng_cv</span><span class="tok-p">;</span> + +<span class="tok-kt">int</span> <span class="tok-nf">nng_cv_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_cv</span> <span class="tok-o">**</span><span class="tok-n">cvp</span><span class="tok-p">,</span> <span class="tok-n">nng_mtx</span> <span class="tok-o">*</span><span class="tok-n">mtx</span><span class="tok-p">);</span></code></pre> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The <code>nng_cv_alloc()</code> function allocates a condition variable, using +the mutex <em>mtx</em>, and returns it in <em>cvp</em>.</p> +</div> +<div class="paragraph"> +<p>Every condition variable is associated with a mutex, which must be +owned when a thread waits for the condition using +<a href="nng_cv_wait.3supp.html"><code>nng_cv_wait()</code></a> or +<a href="nng_cv_until.3supp.html"><code>nng_cv_until()</code></a>. +The mutex must also be owned when signaling the condition using the +<a href="nng_cv_wake.3supp.html"><code>nng_cv_wake()</code></a> or +<a href="nng_cv_wake1.3supp.html"><code>nng_cv_wake1()</code></a> functions.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_return_values">RETURN VALUES</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>This function returns 0 on success, and non-zero otherwise.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_errors">ERRORS</h2> +<div class="sectionbody"> +<div class="hdlist"> +<table> +<tr> +<td class="hdlist1"> +<code>NNG_ENOMEM</code> +</td> +<td class="hdlist2"> +<p>Insufficient free memory exists.</p> +</td> +</tr> +</table> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_see_also">SEE ALSO</h2> +<div class="sectionbody"> +<div class="paragraph text-left"> +<p><a href="nng_cv_free.3supp.html">nng_cv_free(3supp)</a>, +<a href="nng_cv_until.3supp.html">nng_cv_until(3supp)</a>, +<a href="nng_cv_wait.3supp.html">nng_cv_wait(3supp)</a>, +<a href="nng_cv_wake.3supp.html">nng_cv_wake(3supp)</a>, +<a href="nng_cv_wake1.3supp.html">nng_cv_wake1(3supp)</a>, +<a href="nng_mtx_alloc.3supp.html">nng_mtx_alloc(3supp)</a>, +<a href="nng_strerror.3.html">nng_strerror(3)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> |
