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
|
= nng_stat_desc(3)
//
// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// 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_stat_desc - get statistic description
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
typedef struct nng_stat nng_stat;
const char *nng_stat_desc(nng_stat *stat);
----
== DESCRIPTION
The `nng_stat_desc()` function returns a brief, human-readable description
for the statistic _stat_.
TIP: This description can be used for a tool-tip in user interfaces
displaying these statistic values.
NOTE: At this time, only English descriptions are provided.
== RETURN VALUES
The description of statistic _stat_.
== ERRORS
None.
== SEE ALSO
[.text-left]
<<libnng.3#,libnng(3)>>,
<<nng_stat_name.3#,nng_stats_name(3)>>,
<<nng_stats_get.3#,nng_stats_get(3)>>,
<<nng_stat.5#,nng_stat(5)>>,
<<nng.7#,nng(7)>>
|
