From edd3b6bc34f211bd3d58642d0c69ce1b5bb9dc3b Mon Sep 17 00:00:00 2001 From: gdamore Date: Thu, 9 Oct 2025 01:22:20 +0000 Subject: deploy: 9c834956456924df7c885ab8b79573721acaff5c --- ref/api/stats.html | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) (limited to 'ref/api/stats.html') diff --git a/ref/api/stats.html b/ref/api/stats.html index aa0eeec9..2f7a5534 100644 --- a/ref/api/stats.html +++ b/ref/api/stats.html @@ -278,7 +278,7 @@ subject to change at any time and without notice.

The nng_stats_get function takes a snapshot of the statistics for the system and returns it through the pointer statsp. -This function may return NNG_ENOMEM if memory is exhausted, or NNG_ENOTSUP if the statistics +This function may return NNG_ENOMEM if memory is exhausted, or NNG_ENOTSUP if the statistics support is not enabled in the build, but is otherwise expected to return zero.

Freeing a Snapshot

void nng_stats_free(nng_stat *stat);
@@ -312,8 +312,8 @@ const nng_stat *nng_stat_find_listener(const nng_stat *stat, nng_dialer listener
 const nng_stat *nng_stat_find_socket(const nng_stat *stat, nng_dialer socket);

Sometimes it is easiest to search for a specific statistic, matching by name, -or possibly to find the tree of statistics associated with a specific socket, -dialer, or listener.

+or possibly to find the tree of statistics associated with a specific socket, +dialer, or listener.

The nng_stat_find functions are provided for this purpose.

The nng_stat_find function returns the first statistic within the subtree of statistics stat, with the given name. If no such statistic can be found, NULL @@ -347,8 +347,8 @@ statistics tree.

The statistic is a counter that only increments. Usually the change in the value of the statistic is more interesting (as a rate) than the absolute value at any given time. The value should -be obtained using nng_stat_value. -The units will be given by the value returned from nng_stat_unit.

+be obtained using nng_stat_value. +The units will be given by the value returned from nng_stat_unit.

  • NNG_STAT_LEVEL: @@ -357,25 +357,25 @@ to a specific value at a specific time. For example, this may represent the number of messages currently queued for some operation, or the link speed of a network interface. Most often the absolute value is more interesting than the change in the value over time. Again the value can be obtained with -nng_stat_value, and any appropriate unit of measurement -with nng_stat_unit.

    +nng_stat_value, and any appropriate unit of measurement +with nng_stat_unit.

  • NNG_STAT_STRING: The statistic is a string, such as a name. The value -of the string can be obtained with nng_stat_string. +of the string can be obtained with nng_stat_string. The value of this string -will remain valid until the snapshot is deallocated with nng_stats_free.

    +will remain valid until the snapshot is deallocated with nng_stats_free.

  • NNG_STAT_BOOLEAN: The value of the statistic is a truth value (either true -or false) and can be obtained with nng_stat_bool.

    +or false) and can be obtained with nng_stat_bool.

  • NNG_STAT_ID: The value of the statistic is a numeric identifier, such as a socket -identifier. The value can be obtained with nng_stat_value, +identifier. The value can be obtained with nng_stat_value, and will be fixed for the life of the statistic.

    • @@ -386,18 +386,18 @@ bool nng_stat_bool(const nng_stat *stat);

    These functions return the value associated with the statistic.

    The nng_stat_value function returns the the numeric value for the statistic stat -of type NNG_STAT_COUNTER, NNG_STAT_LEVEL, or NNG_STAT_ID. +of type NNG_STAT_COUNTER, NNG_STAT_LEVEL, or NNG_STAT_ID. If stat is not one of these types, then it returns zero.

    The nng_stat_bool function returns the Boolean value (either true or false) for the statistic stat of -type NNG_STAT_BOOLEAN. If the statistics is not of this type, then it returns false.

    +type NNG_STAT_BOOLEAN. If the statistics is not of this type, then it returns false.

    The nng_stat_string function returns a pointer to a string value for the statistic stat, -of type NNG_STAT_STRING. This string will remain valid until the snapshot that -stat was collected with is deallocated with nng_stats_free. If the statistic +of type NNG_STAT_STRING. This string will remain valid until the snapshot that +stat was collected with is deallocated with nng_stats_free. If the statistic is not of type NNG_STAT_STRING, then NULL is returned.

    Statistic Units

    int nng_stat_unit(const nng_stat *stat);
    -

    For statistics of type NNG_STAT_COUNTER or NNG_STAT_LEVEL, +

    For statistics of type NNG_STAT_COUNTER or NNG_STAT_LEVEL, it is often useful to know what that quantity being reported measures. The following units may be returned from nng_stat_unit for such a statistic: