aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/api/util/nng_msleep.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-06 17:10:44 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-06 17:11:55 -0700
commitd9baafa0626e350a185dfe7b886039ff16dddb57 (patch)
tree1643f0aabad35388b53c5dd3c815e772528dc2ff /docs/ref/api/util/nng_msleep.md
parentfa271628fc0d92df1d453cc4e1b4f715e04fa8c3 (diff)
downloadnng-d9baafa0626e350a185dfe7b886039ff16dddb57.tar.gz
nng-d9baafa0626e350a185dfe7b886039ff16dddb57.tar.bz2
nng-d9baafa0626e350a185dfe7b886039ff16dddb57.zip
Convert nng_clock and nng_msleep docs to mdbook
Diffstat (limited to 'docs/ref/api/util/nng_msleep.md')
-rw-r--r--docs/ref/api/util/nng_msleep.md32
1 files changed, 32 insertions, 0 deletions
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