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_unit.3.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_unit.3.adoc')
| -rw-r--r-- | docs/man/nng_stat_unit.3.adoc | 86 |
1 files changed, 0 insertions, 86 deletions
diff --git a/docs/man/nng_stat_unit.3.adoc b/docs/man/nng_stat_unit.3.adoc deleted file mode 100644 index f7136e1f..00000000 --- a/docs/man/nng_stat_unit.3.adoc +++ /dev/null @@ -1,86 +0,0 @@ -= nng_stat_unit(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_unit - get statistic unit - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> - -typedef struct nng_stat nng_stat; - -enum { - NNG_UNIT_NONE, - NNG_UNIT_BYTES, - NNG_UNIT_MESSAGES, - NNG_UNIT_MILLIS, - NNG_UNIT_EVENTS -}; - -int nng_stat_unit(nng_stat *stat); ----- - -== DESCRIPTION - -The `nng_stat_unit()` function returns the unit of quantity measured -by the statistic _stat_. - -The returned value will be one of the following values: - -((`NNG_UNIT_NONE`)):: -There are no particular units measured. -In some cases there may be units, but the type of the unit will be obvious -from the name (see xref:nng_stat_name.3.adoc[`nng_stat_name()`]) of the statistic. - -((`NNG_UNIT_BYTES`)):: -The statistic is a count of bytes. - -((`NNG_UNIT_MESSAGES`)):: -The statistic is a count of messages. -Typically, one message corresponds to a single xref:nng_msg.5.adoc[`nng_msg`] structure. - -((`NNG_UNIT_MILLIS`)):: -The statistic is a count of milliseconds. - -((`NNG_STAT_EVENTS`)):: -The statistic is a count of some other type of event. - -For statistics that are neither `NNG_STAT_COUNTER` nor `NNG_STAT_LEVEL` -type (see xref:nng_stat_type.3.adoc[`nng_stat_type()`]), the unit will -generally be `NNG_UNIT_NONE`. - -TIP: Normally rates can be calculated for `NNG_STAT_COUNTER` values for -any of these units, but for `NNG_UNIT_MILLIS` rate calculations are generally -meaningless. - -== RETURN VALUES - -The units measured by _stat_. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:libnng.3.adoc[libnng(3)], -xref:nng_stats_get.3.adoc[nng_stats_get(3)], -xref:nng_stat_name.3.adoc[nng_stat_name(3)], -xref:nng_stat_type.3.adoc[nng_stat_type(3)], -xref:nng_stat_value.3.adoc[nng_stat_value(3)], -xref:nng_msg.5.adoc[nng_msg(5)], -xref:nng_stat.5.adoc[nng_stat(5)], -xref:nng.7.adoc[nng(7)] |
