blob: 61c1573a5128152fb8d9415d3da97776c629794d (
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
|
## nng_stat_unit
Get statistic unit.
### Synopsis
```c
#include <nng/nng.h>
typedef struct nng_stat nng_stat;
enum {
NNG_UNIT_NONE,
NNG_UNIT_BYTES,
NNG_UNIT_MESSAGES,
NNG_UNIT_MILLIS,
NNG_UNIT_EVENTS
};
int nng_stat_unit(nng_stat *stat);
```
### Description
The `nng_stat_unit` function returns the unit of quantity measured by the statistic _stat_.
The returned value will be one of the following values:
((`NNG_UNIT_NONE`))::
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 xref:nng_stat_name.adoc[`nng_stat_name`]) of the statistic.
((`NNG_UNIT_BYTES`))::
The statistic is a count of bytes.
((`NNG_UNIT_MESSAGES`))::
The statistic is a count of messages.
((`NNG_UNIT_MILLIS`))::
The statistic is a count of milliseconds.
((`NNG_STAT_EVENTS`))::
The statistic is a count of some other type of event.
For statistics that are neither `NNG_STAT_COUNTER` nor `NNG_STAT_LEVEL` type (see xref:nng_stat_type.adoc[`nng_stat_type`]), the unit will generally be `NNG_UNIT_NONE`.
TIP: Normally rates can be calculated for `NNG_STAT_COUNTER` values for any of these units, but for `NNG_UNIT_MILLIS` rate calculations are generally meaningless.
### Return Values
The units measured by _stat_.
### See Also
xref:nng_stats_get.adoc[nng_stats_get],
xref:nng_stat_name.adoc[nng_stat_name],
xref:nng_stat_type.adoc[nng_stat_type],
xref:nng_stat_value.adoc[nng_stat_value]
|
