diff options
Diffstat (limited to 'docs/ref/api')
| -rw-r--r-- | docs/ref/api/util/index.md | 2 | ||||
| -rw-r--r-- | docs/ref/api/util/nng_clock.md | 47 | ||||
| -rw-r--r-- | docs/ref/api/util/nng_msleep.md | 32 |
3 files changed, 81 insertions, 0 deletions
diff --git a/docs/ref/api/util/index.md b/docs/ref/api/util/index.md index 62c5fc67..9f155b65 100644 --- a/docs/ref/api/util/index.md +++ b/docs/ref/api/util/index.md @@ -1,3 +1,5 @@ # Utility Functions +- [nng_clock](nng_clock.md) - [nng_id_map](nng_id_map.md) +- [nng_msleep](nng_msleep.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 diff --git a/docs/ref/api/util/nng_msleep.md b/docs/ref/api/util/nng_msleep.md new file mode 100644 index 00000000..ed3b8b27 --- /dev/null +++ b/docs/ref/api/util/nng_msleep.md @@ -0,0 +1,32 @@ +# 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 `nng_msleep()` 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 |
