53 lines
1.1 KiB
Text
53 lines
1.1 KiB
Text
|
= 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]
|
||
|
|
xref:libnng.3.adoc[libnng(3)],
|
||
|
|
xref:nng_stat_name.3.adoc[nng_stats_name(3)],
|
||
|
|
xref:nng_stats_get.3.adoc[nng_stats_get(3)],
|
||
|
|
xref:nng_stat.5.adoc[nng_stat(5)],
|
||
|
|
xref:nng.7.adoc[nng(7)]
|