summaryrefslogtreecommitdiff
path: root/docs/ref/util/nng_msleep.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-04-05 00:36:24 -0700
committerGarrett D'Amore <garrett@damore.org>2024-04-05 00:36:24 -0700
commit05beb9ed7d75142483e3963501898fd9f32d7508 (patch)
tree773ca1568fe3df45e75e2b1c2409ea476965a4ae /docs/ref/util/nng_msleep.adoc
parentab7b5393f3c34b49e112f407ea61abc5cfb5933f (diff)
downloadnng-05beb9ed7d75142483e3963501898fd9f32d7508.tar.gz
nng-05beb9ed7d75142483e3963501898fd9f32d7508.tar.bz2
nng-05beb9ed7d75142483e3963501898fd9f32d7508.zip
Added nng_strerror and nng_msleep.
Diffstat (limited to 'docs/ref/util/nng_msleep.adoc')
-rw-r--r--docs/ref/util/nng_msleep.adoc22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/ref/util/nng_msleep.adoc b/docs/ref/util/nng_msleep.adoc
new file mode 100644
index 00000000..83e69c60
--- /dev/null
+++ b/docs/ref/util/nng_msleep.adoc
@@ -0,0 +1,22 @@
+## nng_msleep
+
+Sleep milliseconds.
+
+### Synopsis
+
+```c
+#include <nng/nng.h>
+#include <nng/supplemental/util/platform.h>
+
+void nng_msleep(nng_duration msec);
+```
+
+### Description
+
+The `nng_msleep` blocks the caller for at least _msec_ milliseconds.footnote:[This function may block for longer than requested.
+The actual wait time is determined by the timer resolution of the underlying system.]
+
+### See Also
+
+xref:../aio/nng_sleep_aio.adoc[nng_sleep_aio],
+xref:nng_clock.adoc[nng_clock]