From c7f7bcb6e2cfbf66c7fab158b0ac02890243b5bb Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 8 Apr 2024 07:40:06 -0700 Subject: Converted stats pages --- docs/man/nng_stat_timestamp.3.adoc | 60 -------------------------------------- 1 file changed, 60 deletions(-) delete mode 100644 docs/man/nng_stat_timestamp.3.adoc (limited to 'docs/man/nng_stat_timestamp.3.adoc') diff --git a/docs/man/nng_stat_timestamp.3.adoc b/docs/man/nng_stat_timestamp.3.adoc deleted file mode 100644 index 74d827e8..00000000 --- a/docs/man/nng_stat_timestamp.3.adoc +++ /dev/null @@ -1,60 +0,0 @@ -= nng_stat_timestamp(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_timestamp - get statistic timestamp - -== SYNOPSIS - -[source, c] ----- -#include - -typedef struct nng_stat nng_stat; - -uint64_t nng_stat_timestamp(nng_stat *stat); ----- - -== DESCRIPTION - -The `nng_stat_timestamp()` function returns the a timestamp, which is measured -as a number of milliseconds since some arbitrary value in the past. - -Even within the same snapshot, statistics might have different timestamp -values, as the timestamp represents the time when that particular statistic -was captured. - -TIP: These values are intended to facilitate calculation of rates, by -comparing values from one snapshot with a subsequent one. - -TIP: The values used here have the same offset as the -xref:nng_clock.3supp.adoc[`nng_clock()`] supplemental function. -This can be useful when converting these values to local clock time. - -== RETURN VALUES - -The timestamp when _stat_ was captured, measured as a number of -milliseconds since some time in the past. - -== 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_value.3.adoc[nng_stat_value(3)], -xref:nng_clock.3supp.adoc[nng_clock(3supp)], -xref:nng_stat.5.adoc[nng_stat(5)], -xref:nng.7.adoc[nng(7)] -- cgit v1.2.3-70-g09d2