aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_stat_find_socket.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2020-01-23 21:20:24 -0800
committerGarrett D'Amore <garrett@damore.org>2020-01-23 21:20:24 -0800
commit6a630e375056c3fa65a8b39f01de7661a68ae411 (patch)
tree2857bf1f89ee5322e7163011bb9949db345f9538 /docs/man/nng_stat_find_socket.adoc
parentf7800d315d657d7a702c040d8e3b295d0584b59c (diff)
downloadnng-6a630e375056c3fa65a8b39f01de7661a68ae411.tar.gz
nng-6a630e375056c3fa65a8b39f01de7661a68ae411.tar.bz2
nng-6a630e375056c3fa65a8b39f01de7661a68ae411.zip
fix sections for stat man pages
Diffstat (limited to 'docs/man/nng_stat_find_socket.adoc')
-rw-r--r--docs/man/nng_stat_find_socket.adoc56
1 files changed, 0 insertions, 56 deletions
diff --git a/docs/man/nng_stat_find_socket.adoc b/docs/man/nng_stat_find_socket.adoc
deleted file mode 100644
index eb03d5ea..00000000
--- a/docs/man/nng_stat_find_socket.adoc
+++ /dev/null
@@ -1,56 +0,0 @@
-= nng_stat_find_socket(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_socket - find socket statistics
-
-== SYNOPSIS
-
-[source,c]
-----
-#include <nng/nng.h>
-
-typedef struct nng_stat nng_stat;
-typedef struct nng_socket nng_socket;
-
-nng_stat *nng_stat_find_socket(nng_stat *stat, nng_socket socket);
-----
-
-== DESCRIPTION
-
-The `nng_stat_find_socket()` function returns the statistics tree within _stat_ associated with the socket _socket_, if such a tree exists.
-Otherwise `NULL` is returned.
-
-Generally, there will be child statistics of the returned value, each corresponding to a specific metric.
-These can be further scanned using either
-xref:nng_stat_find.3.adoc[nng_stat_find(3)]
-or by walking the tree with
-xref:nng_stat_child.3.adoc[nng_stat_child(3)].
-
-== 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.3.adoc[nng_stat_find(3)],
-xref:nng_stat_find_dialer.3.adoc[nng_stat_find_dialer(3)],
-xref:nng_stat_find_listener.3.adoc[nng_stat_find_listener(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)]