diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-20 22:25:53 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-20 22:25:53 -0700 |
| commit | e4e85293cfa0e359b50cd2b57ca0c476632e0c22 (patch) | |
| tree | 9f39dde5a4c4a5623041ce150e4f5fbbe15fde14 /docs/ref/api/util/nng_clock.md | |
| parent | 976d62059097ef715687cbd0abb12ab6f957c882 (diff) | |
| download | nng-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/nng_clock.md')
| -rw-r--r-- | docs/ref/api/util/nng_clock.md | 46 |
1 files changed, 0 insertions, 46 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 |