summaryrefslogtreecommitdiff
path: root/man/v1.3.2/nng_stat_value.3.html
blob: 95b0039fa143531027affb51725800531e4c1f0f (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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
---
version: v1.3.2
layout: manpage_v2
---
<h1>nng_stat_value(3)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_stat_value - get statistic value</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">&lt;nng/nng.h&gt;</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_stat</span> <span class="tok-n">nng_stat</span><span class="tok-p">;</span>

<span class="tok-n">uint64_t</span> <span class="tok-nf">nng_stat_value</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span> <span class="tok-o">*</span><span class="tok-n">stat</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_stat_value()</code> function returns a numeric value for the statistic <em>stat</em>.
If the statistic has a boolean value, then zero is returned for <code>false</code>, and
one is returned for <code>true</code>.
Otherwise, if the statistic is not of numeric type, then zero is returned.
See <a href="nng_stat_type.3.html"><code>nng_stat_type()</code></a> for a description of statistic types.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The numeric or boolean value associated with <em>stat</em>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph text-left">
<p><a href="libnng.3.html">libnng(3)</a>,
<a href="nng_stats_get.3.html">nng_stats_get(3)</a>,
<a href="nng_stat_type.3.html">nng_stat_type(3)</a>,
<a href="nng_stat_unit.3.html">nng_stat_unit(3)</a>,
<a href="nng_stat.5.html">nng_stat(5)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>