From 66ff33813a8cd9d4cba96280bb613762fb0c2ce2 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Wed, 11 Nov 2020 21:29:54 -0800
Subject: 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.)
---
 docs/man/nng_stat_bool.3.adoc | 50 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 docs/man/nng_stat_bool.3.adoc

(limited to 'docs/man/nng_stat_bool.3.adoc')

diff --git a/docs/man/nng_stat_bool.3.adoc b/docs/man/nng_stat_bool.3.adoc
new file mode 100644
index 00000000..17b7bbca
--- /dev/null
+++ b/docs/man/nng_stat_bool.3.adoc
@@ -0,0 +1,50 @@
+= nng_stat_value(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_value - get statistic value
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+
+typedef struct nng_stat nng_stat;
+
+bool nng_stat_bool(nng_stat *stat);
+----
+
+== DESCRIPTION
+
+The `nng_stat_bool()` function returns the Boolean value for the statistic _stat_.
+Otherwise, if the statistic is not of Boolean type, the result is indeterminate.
+See xref:nng_stat_type.3.adoc[`nng_stat_type()`] for a description of statistic types.
+
+== RETURN VALUES
+
+The boolean value associated with _stat_.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+[.text-left]
+xref:libnng.3.adoc[libnng(3)],
+xref:nng_stats_get.3.adoc[nng_stats_get(3)],
+xref:nng_stat_type.3.adoc[nng_stat_type(3)],
+xref:nng_stat_unit.3.adoc[nng_stat_unit(3)],
+xref:nng_stat_value.3.adoc[nng_stat_value(3)],
+xref:nng_stat.5.adoc[nng_stat(5)],
+xref:nng.7.adoc[nng(7)]
-- 
cgit v1.2.3-70-g09d2

