aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_stat_string.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_string.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_string.3.adoc')
-rw-r--r--docs/man/nng_stat_string.3.adoc54
1 files changed, 0 insertions, 54 deletions
diff --git a/docs/man/nng_stat_string.3.adoc b/docs/man/nng_stat_string.3.adoc
deleted file mode 100644
index 4c65fb1a..00000000
--- a/docs/man/nng_stat_string.3.adoc
+++ /dev/null
@@ -1,54 +0,0 @@
-= nng_stat_string(3)
-//
-// Copyright 2020 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_string - get statistic string value
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-typedef struct nng_stat nng_stat;
-
-const char *nng_stat_string(nng_stat *stat);
-----
-
-== DESCRIPTION
-
-The `nng_stat_string()` function returns a string value for the statistic _stat_,
-which must be of type `NNG_STAT_STRING` (see xref:nng_stat_type.3.adoc[`nng_stat_type(3)`]).
-
-If the statistic is not of type `NNG_STAT_STRING`, then `NULL` will be returned.
-
-NOTE: The returned string is valid until xref:nng_stats_free.3.adoc[`nng_stats_free()`] is called to
-free the memory for the snapshot.
-
-== RETURN VALUES
-
-The string value associated with _stat_, or `NULL` if the statistic is not
-a string type.
-
-== 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_type.3.adoc[nng_stats_type(3)],
-xref:nng_stat_value.3.adoc[nng_stats_value(3)],
-xref:nng_stat.5.adoc[nng_stat(5)],
-xref:nng.7.adoc[nng(7)]