From a693a53e2302fe9cc60c1b5d2bf59c42032b20a3 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Tue, 31 Dec 2019 15:09:20 -0800
Subject: fixes #1081 Use after free possible in stats fixes #1080 Desire
 better way to access statistics for NNG objects

We've also added a test that uses some of this, in order to verify
that the req protocol rejects invalid peers.
---
 docs/man/nng_stat_find.adoc | 52 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 docs/man/nng_stat_find.adoc

(limited to 'docs/man/nng_stat_find.adoc')

diff --git a/docs/man/nng_stat_find.adoc b/docs/man/nng_stat_find.adoc
new file mode 100644
index 00000000..4f4103ea
--- /dev/null
+++ b/docs/man/nng_stat_find.adoc
@@ -0,0 +1,52 @@
+= nng_stat_find(3)
+//
+// Copyright 2019 Staysail Systems, Inc. <info@staysail.tech>
+//
+// 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_find - find statistic by name
+
+== SYNOPSIS
+
+[source,c]
+----
+#include <nng/nng.h>
+
+typedef struct nng_stat nng_stat;
+
+nng_stat *nng_stat_find(nng_stat *stat, const char *name);
+----
+
+== DESCRIPTION
+
+The `nng_stat_find()` function searches the statistics tree _stat_, looking for a statistic whose name is _name_.
+If it finds one, it returns it.
+Otherwise `NULL` is returned.
+
+NOTE: If multiple statistics have that name, then only the first match is returned.
+
+== RETURN VALUES
+
+The matching statistic, or NULL if no match is found.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+[.text-left]
+xref:libnng.3.adoc[libnng(3)],
+xref:nng_stat_child.3.adoc[nng_stat_child(3)],
+xref:nng_stat_find_dialer.3.adoc[nng_stat_find_dialer(3)],
+xref:nng_stat_find_listener.3.adoc[nng_stat_find_listner(3)],
+xref:nng_stat_find_socket.3.adoc[nng_stat_find_socket(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)]
-- 
cgit v1.2.3-70-g09d2

