aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/api/util
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-20 22:25:53 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-20 22:25:53 -0700
commite4e85293cfa0e359b50cd2b57ca0c476632e0c22 (patch)
tree9f39dde5a4c4a5623041ce150e4f5fbbe15fde14 /docs/ref/api/util
parent976d62059097ef715687cbd0abb12ab6f957c882 (diff)
downloadnng-e4e85293cfa0e359b50cd2b57ca0c476632e0c22.tar.gz
nng-e4e85293cfa0e359b50cd2b57ca0c476632e0c22.tar.bz2
nng-e4e85293cfa0e359b50cd2b57ca0c476632e0c22.zip
docs: Move time related functions into single chapter.
Diffstat (limited to 'docs/ref/api/util')
-rw-r--r--docs/ref/api/util/nng_clock.md46
-rw-r--r--docs/ref/api/util/nng_duration.md33
-rw-r--r--docs/ref/api/util/nng_msleep.md32
3 files changed, 0 insertions, 111 deletions
diff --git a/docs/ref/api/util/nng_clock.md b/docs/ref/api/util/nng_clock.md
deleted file mode 100644
index ca6d1c6e..00000000
--- a/docs/ref/api/util/nng_clock.md
+++ /dev/null
@@ -1,46 +0,0 @@
-# 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 {{i:`nng_clock`}}{{hi: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
diff --git a/docs/ref/api/util/nng_duration.md b/docs/ref/api/util/nng_duration.md
deleted file mode 100644
index 9ad76256..00000000
--- a/docs/ref/api/util/nng_duration.md
+++ /dev/null
@@ -1,33 +0,0 @@
-# nng_duration
-
-## NAME
-
-nng_duration --- relative time in milliseconds
-
-## SYNOPSIS
-
-```c
-#include <nng/nng.h>
-
-typedef int32_t nng_duration;
-
-#define NNG_DURATION_INFINITE (-1)
-#define NNG_DURATION_DEFAULT (-2)
-#define NNG_DURATION_ZERO (0)
-```
-
-## DESCRIPTION
-
-An {{i:`nng_duration`}}{{hi:duration}} is a relative time, measured in {{i:milliseconds}}.
-This type is most often used in conjunction with timers and timeouts.
-
-A couple of special values have been set aside, and carry special meanings.
-
-- {{i:`NNG_DURATION_DEFAULT`}}:
- Indicates a context-specific default value should be used.
-
-- {{i:`NNG_DURATION_INFINITE`}}:
- Effectively an infinite duration; used most often to disable timeouts.
-
-- {{i:`NNG_DURATION_ZERO`}}:
- Zero length duration; used to perform an immediate poll.
diff --git a/docs/ref/api/util/nng_msleep.md b/docs/ref/api/util/nng_msleep.md
deleted file mode 100644
index e055b2f9..00000000
--- a/docs/ref/api/util/nng_msleep.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# nng_msleep
-
-## NAME
-
-nng_msleep --- sleep milliseconds
-
-## SYNOPSIS
-
-```c
-#include <nng/nng.h>
-
-typedef int64_t nng_duration;
-
-void nng_msleep(nng_duration msec);
-```
-
-## DESCRIPTION
-
-The {{i:`nng_msleep`}}{{hi:sleep}} blocks the caller for at least _msec_ milliseconds.
-
-> [!NOTE]
-> This function may block for longer than requested.
-> The actual wait time is determined by the capabilities of the
-> underlying system.
-
-## SEE ALSO
-
-[nng_sleep_aio][nng_sleep_aio],
-[nng_clock][nng_clock]
-
-[nng_clock]: ../util/nng_clock.md
-[nng_sleep_aio]: ../aio/nng_sleep_aio.md