diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-15 20:31:04 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-15 20:31:04 -0700 |
| commit | 4c83442e174b186f5ee22bc8744cc7cc2a890e13 (patch) | |
| tree | 515c5c1b9be97cf876b32bd5359f88ecc7e1aa8a /docs/man/nng_stat.5.adoc | |
| parent | cc13903167e540c0e306ed7faa0b58a8bcd12066 (diff) | |
| download | nng-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.5.adoc')
| -rw-r--r-- | docs/man/nng_stat.5.adoc | 81 |
1 files changed, 0 insertions, 81 deletions
diff --git a/docs/man/nng_stat.5.adoc b/docs/man/nng_stat.5.adoc deleted file mode 100644 index 218bafb2..00000000 --- a/docs/man/nng_stat.5.adoc +++ /dev/null @@ -1,81 +0,0 @@ -= nng_stat(5) - -// Copyright 2019 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 - statistic - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> - -typedef struct nng_stat nng_stat; ----- - -== DESCRIPTION - -An `nng_stat`(((statistic))) represents a statistic. -All statistics have names (xref:nng_stat_name.3.adoc[`nng_stat_name()`]) and -descriptions (xref:nng_stat_desc.3.adoc[`nng_stat_desc()`]), and are -typed (xref:nng_stat_type.3.adoc[`nng_stat_type()`]). - -Most statistics are numeric, -and thus carry a value (xref:nng_stat_value.3.adoc[`nng_stat_value()`]) -and frequently also a unit that the value measures (xref:nng_stat_unit.3.adoc[`nng_stat_unit()`]). - -Some statistics however, are simply strings (xref:nng_stat_string.3.adoc[`nng_stat_string()`]), -and thus carry no numeric value. - -Statistics are organized as a tree, and any given statistic can have siblings -(xref:nng_stat_next.3.adoc[`nng_stat_next()`]). -Note however that generally only `NNG_STAT_SCOPE` statistics, which are -act as placeholders in the tree (and carry no value), -will have children (xref:nng_stat_child.3.adoc[`nng_stat_child()`]). - -A tree of statistics is collected using xref:nng_stats_get.3.adoc[`nng_stats_get()`], -and can be freed when no longer needed with xref:nng_stats_free.3.adoc[`nng_stats_free()`]. -This collection process is generally performed in a way to minimize impact -to running operations, but there is still some impact caused by collection -of statistics. - -The time when a statistic's value is captured can be obtained using -xref:nng_stat_timestamp.3.adoc[`nng_stat_timestamp()`], which is useful for -measuring rates of change in certain statistics. - -NOTE: The presence, names, and meanings of any given statistic are -subject to change at any time. These statistics are provided as an aid -for debugging, and should generally not be relied upon for programmatic -behaviors. - -NOTE: Statistics may be disabled by build-time configuration options, -in order to reduce program size and run-time overheads. - -== SEE ALSO - -[.text-left] -xref:libnng.3.adoc[libnng(3)], -xref:nng_stats_free.3.adoc[nng_stats_free(3)], -xref:nng_stats_get.3.adoc[nng_stats_get(3)], -xref:nng_stat_child.3.adoc[nng_stat_child(3)], -xref:nng_stat_desc.3.adoc[nng_stat_desc(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_stat_find_socket.3.adoc[nng_stat_find_socket(3)], -xref:nng_stat_name.3.adoc[nng_stat_name(3)], -xref:nng_stat_next.3.adoc[nng_stat_next(3)], -xref:nng_stat_string.3.adoc[nng_stat_string(3)], -xref:nng_stat_timestamp.3.adoc[nng_stat_timestamp(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.7.adoc[nng(7)] |
