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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
---
version: tip
layout: manpage_v2
title: nng_stat_unit(3)
---
<h1>nng_stat_unit(3)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_stat_unit - get statistic unit</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></span><span class="tok-cp">#include</span><span class="tok-w"> </span><span class="tok-cpf"><nng/nng.h></span>
<span class="tok-k">typedef</span><span class="tok-w"> </span><span class="tok-k">struct</span><span class="tok-w"> </span><span class="tok-nc">nng_stat</span><span class="tok-w"> </span><span class="tok-n">nng_stat</span><span class="tok-p">;</span>
<span class="tok-k">enum</span><span class="tok-w"> </span><span class="tok-p">{</span>
<span class="tok-w"> </span><span class="tok-n">NNG_UNIT_NONE</span><span class="tok-p">,</span>
<span class="tok-w"> </span><span class="tok-n">NNG_UNIT_BYTES</span><span class="tok-p">,</span>
<span class="tok-w"> </span><span class="tok-n">NNG_UNIT_MESSAGES</span><span class="tok-p">,</span>
<span class="tok-w"> </span><span class="tok-n">NNG_UNIT_MILLIS</span><span class="tok-p">,</span>
<span class="tok-w"> </span><span class="tok-n">NNG_UNIT_EVENTS</span>
<span class="tok-p">};</span>
<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nng_stat_unit</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span><span class="tok-w"> </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_unit()</code> function returns the unit of quantity measured
by the statistic <em>stat</em>.</p>
</div>
<div class="paragraph">
<p>The returned value will be one of the following values:</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>NNG_UNIT_NONE</code></dt>
<dd>
<p>There are no particular units measured.
In some cases there may be units, but the type of the unit will be obvious
from the name (see <a href="nng_stat_name.3.html"><code>nng_stat_name()</code></a>) of the statistic.</p>
</dd>
<dt class="hdlist1"><code>NNG_UNIT_BYTES</code></dt>
<dd>
<p>The statistic is a count of bytes.</p>
</dd>
<dt class="hdlist1"><code>NNG_UNIT_MESSAGES</code></dt>
<dd>
<p>The statistic is a count of messages.
Typically, one message corresponds to a single <a href="nng_msg.5.html"><code>nng_msg</code></a> structure.</p>
</dd>
<dt class="hdlist1"><code>NNG_UNIT_MILLIS</code></dt>
<dd>
<p>The statistic is a count of milliseconds.</p>
</dd>
<dt class="hdlist1"><code>NNG_STAT_EVENTS</code></dt>
<dd>
<p>The statistic is a count of some other type of event.</p>
</dd>
</dl>
</div>
<div class="paragraph">
<p>For statistics that are neither <code>NNG_STAT_COUNTER</code> nor <code>NNG_STAT_LEVEL</code>
type (see <a href="nng_stat_type.3.html"><code>nng_stat_type()</code></a>), the unit will
generally be <code>NNG_UNIT_NONE</code>.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
Normally rates can be calculated for <code>NNG_STAT_COUNTER</code> values for
any of these units, but for <code>NNG_UNIT_MILLIS</code> rate calculations are generally
meaningless.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The units measured by <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_name.3.html">nng_stat_name(3)</a>,
<a href="nng_stat_type.3.html">nng_stat_type(3)</a>,
<a href="nng_stat_value.3.html">nng_stat_value(3)</a>,
<a href="nng_msg.5.html">nng_msg(5)</a>,
<a href="nng_stat.5.html">nng_stat(5)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>
|
