summaryrefslogtreecommitdiff
path: root/docs/reference/src/api/nng_clock.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-03-24 22:19:42 -0700
committerGarrett D'Amore <garrett@damore.org>2024-03-24 22:19:42 -0700
commit331bd5a7c360083f245fe6c82afa38dd05c4a9c9 (patch)
treef7a50976a4a6a717660d1c94a9808e896c3c2059 /docs/reference/src/api/nng_clock.md
parent962553386968a528593665e228b9424de84d7f4e (diff)
downloadnng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.tar.gz
nng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.tar.bz2
nng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.zip
More org stuff
Diffstat (limited to 'docs/reference/src/api/nng_clock.md')
-rw-r--r--docs/reference/src/api/nng_clock.md43
1 files changed, 0 insertions, 43 deletions
diff --git a/docs/reference/src/api/nng_clock.md b/docs/reference/src/api/nng_clock.md
deleted file mode 100644
index 37be0d0c..00000000
--- a/docs/reference/src/api/nng_clock.md
+++ /dev/null
@@ -1,43 +0,0 @@
-# nng_clock()
-
-## NAME
-
-nng_clock - get time
-
-## SYNOPSIS
-
-```c
-#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
-
-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)