From d83b96faeb02d7a3574e63880141d6b23f31ced1 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Wed, 22 Aug 2018 08:56:53 -0700
Subject: fixes #4 Statistics support

This introduces new public APIs for obtaining statistics,
and adds some generic stats for dialers, listeners, pipes, and
sockets.  Also added are stats for inproc and pairv1 protocol.

The other protocols and transports will have stats added
incrementally as time goes on.

A simple test program, and man pages are provided for this.
Start by looking at nng_stat(5).

Statistics does have some impact, and they can be disabled by
using the advanced NNG_ENABLE_STATS (setting it to OFF, it's
ON by default) if you need to build a minimized configuration.
---
 docs/man/nng_stat_name.3.adoc | 47 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 docs/man/nng_stat_name.3.adoc

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

diff --git a/docs/man/nng_stat_name.3.adoc b/docs/man/nng_stat_name.3.adoc
new file mode 100644
index 00000000..aaf854f5
--- /dev/null
+++ b/docs/man/nng_stat_name.3.adoc
@@ -0,0 +1,47 @@
+= nng_version(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_name - get statistic name
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+
+typedef struct nng_stat nng_stat;
+
+const char *nng_stat_name(nng_stat *stat);
+----
+
+== DESCRIPTION
+
+The `nng_stat_name()` function returns the name for the statistic _stat_.
+
+NOTE: The global root statistic will have the empty string ("") as it`'s name.
+
+== RETURN VALUES
+
+The name of statistic _stat_.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+[.text-left]
+<<libnng.3#,libnng(3)>>,
+<<nng_stats_get.3#,nng_stats_get(3)>>,
+<<nng_stat.5#,nng_stat(5)>>,
+<<nng.7#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2

