aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_stat_value.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2020-11-11 21:29:54 -0800
committerGarrett D'Amore <garrett@damore.org>2020-11-11 23:51:13 -0800
commit66ff33813a8cd9d4cba96280bb613762fb0c2ce2 (patch)
tree4d9230b87715ebb1ff876894cd805ee4da42eccb /docs/man/nng_stat_value.3.adoc
parent53f20bbc4a2bd0d333e0307640883a778de31e2b (diff)
downloadnng-66ff33813a8cd9d4cba96280bb613762fb0c2ce2.tar.gz
nng-66ff33813a8cd9d4cba96280bb613762fb0c2ce2.tar.bz2
nng-66ff33813a8cd9d4cba96280bb613762fb0c2ce2.zip
fixes #1323 stats framework is *way* to heavy
This should reduce the amount of copying, and the overall size used by pipes and other objects quite a bit. (On my system, the sizeof nni_pipe shrank by 400 bytes, for example.)
Diffstat (limited to 'docs/man/nng_stat_value.3.adoc')
-rw-r--r--docs/man/nng_stat_value.3.adoc9
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/man/nng_stat_value.3.adoc b/docs/man/nng_stat_value.3.adoc
index 6f1b9201..32b87e12 100644
--- a/docs/man/nng_stat_value.3.adoc
+++ b/docs/man/nng_stat_value.3.adoc
@@ -1,6 +1,6 @@
= nng_stat_value(3)
//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2020 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
@@ -27,14 +27,12 @@ uint64_t nng_stat_value(nng_stat *stat);
== DESCRIPTION
The `nng_stat_value()` function returns a numeric value for the statistic _stat_.
-If the statistic has a boolean value, then zero is returned for `false`, and
-one is returned for `true`.
-Otherwise, if the statistic is not of numeric type, then zero is returned.
+If the statistic is not of numeric type, then zero is returned.
See xref:nng_stat_type.3.adoc[`nng_stat_type()`] for a description of statistic types.
== RETURN VALUES
-The numeric or boolean value associated with _stat_.
+The numeric value associated with _stat_.
== ERRORS
@@ -45,6 +43,7 @@ None.
[.text-left]
xref:libnng.3.adoc[libnng(3)],
xref:nng_stats_get.3.adoc[nng_stats_get(3)],
+xref:nng_stat_bool.3.adoc[nng_stat_bool(3)],
xref:nng_stat_type.3.adoc[nng_stat_type(3)],
xref:nng_stat_unit.3.adoc[nng_stat_unit(3)],
xref:nng_stat.5.adoc[nng_stat(5)],