aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_stat_find_socket.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-15 20:31:04 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-15 20:31:04 -0700
commit4c83442e174b186f5ee22bc8744cc7cc2a890e13 (patch)
tree515c5c1b9be97cf876b32bd5359f88ecc7e1aa8a /docs/man/nng_stat_find_socket.3.adoc
parentcc13903167e540c0e306ed7faa0b58a8bcd12066 (diff)
downloadnng-4c83442e174b186f5ee22bc8744cc7cc2a890e13.tar.gz
nng-4c83442e174b186f5ee22bc8744cc7cc2a890e13.tar.bz2
nng-4c83442e174b186f5ee22bc8744cc7cc2a890e13.zip
Stats API converted to mdbook.
A number of small errors were fixed, and we tried to restructure this to be a bit more usable to readers.
Diffstat (limited to 'docs/man/nng_stat_find_socket.3.adoc')
-rw-r--r--docs/man/nng_stat_find_socket.3.adoc55
1 files changed, 0 insertions, 55 deletions
diff --git a/docs/man/nng_stat_find_socket.3.adoc b/docs/man/nng_stat_find_socket.3.adoc
deleted file mode 100644
index deea509c..00000000
--- a/docs/man/nng_stat_find_socket.3.adoc
+++ /dev/null
@@ -1,55 +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)]