From d9baafa0626e350a185dfe7b886039ff16dddb57 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Sun, 6 Oct 2024 17:10:44 -0700
Subject: Convert nng_clock and nng_msleep docs to mdbook

---
 docs/ref/api/util/nng_clock.md | 47 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 docs/ref/api/util/nng_clock.md

(limited to 'docs/ref/api/util/nng_clock.md')

diff --git a/docs/ref/api/util/nng_clock.md b/docs/ref/api/util/nng_clock.md
new file mode 100644
index 00000000..f4e9f9d5
--- /dev/null
+++ b/docs/ref/api/util/nng_clock.md
@@ -0,0 +1,47 @@
+# nng_clock
+
+## NAME
+
+nng_clock - get time
+
+## SYNOPSIS
+
+```c
+#include <nng/nng.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]
+or [`nng_aio_set_expire`][nng_aio_set_timeout].
+
+## RETURN VALUES
+
+Milliseconds since reference time.
+
+## SEE ALSO
+
+[nng_cv_until][nng_cv_until],
+[nng_msleep][nng_msleep],
+[nng_sleep_aio][nng_sleep_aio]
+
+[nng_cv_until]: ../thr/nng_cv.md
+[nng_msleep]: ../util/nng_msleep.md
+[nng_sleep_aio]: ../aio/nng_sleep_aio.md
+[nng_aio_set_timeout]: ../aio/nng_aio_set_timeout.md
-- 
cgit v1.2.3-70-g09d2