From b24ef189f1dc9f9bf4889cb420e4645721728036 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 24 Mar 2024 12:53:58 -0700 Subject: Initial swag at mdbook content. This has the nng_a* to nng_c* content converted. Various editorial changes have been made as well. --- docs/reference/src/api/nng_clock.md | 43 +++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/reference/src/api/nng_clock.md (limited to 'docs/reference/src/api/nng_clock.md') diff --git a/docs/reference/src/api/nng_clock.md b/docs/reference/src/api/nng_clock.md new file mode 100644 index 00000000..37be0d0c --- /dev/null +++ b/docs/reference/src/api/nng_clock.md @@ -0,0 +1,43 @@ +# nng_clock() + +## NAME + +nng_clock - get time + +## SYNOPSIS + +```c +#include +#include + +typedef uint64_t nng_time; + +nng_time nng_clock(void); +``` + +## DESCRIPTION + +The `nng_clock()` function returns the number of elapsed milliseconds since some +arbitrary time in the past. +The resolution of the clock depends on the underlying timing facilities +of the system. +This function may be used for timing, but applications should not expect +very fine-grained values. + +> [!NOTE] +> The reference time will be the same for a given program, +> but different programs may have different references. + +This function is intended to help with setting appropriate +timeouts using [`nng_cv_until()`](nng_cv_until.md). + +## RETURN VALUES + +Milliseconds since reference time. + +## SEE ALSO + +[nng_sleep_aio()](nng_sleep_aio.md), +[nng_cv_until()](nng_cv_until.md), +[nng_msleep()](nng_msleep.md), +[nng_duration](nng_duration.md) -- cgit v1.2.3-70-g09d2