From d9baafa0626e350a185dfe7b886039ff16dddb57 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 6 Oct 2024 17:10:44 -0700 Subject: Convert nng_clock and nng_msleep docs to mdbook --- docs/ref/api/util/nng_msleep.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/ref/api/util/nng_msleep.md (limited to 'docs/ref/api/util/nng_msleep.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 + +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 -- cgit v1.2.3-70-g09d2