diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-03-26 23:29:58 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-03-26 23:29:58 -0700 |
| commit | 399a4cdc7e43354b3d103c68f2115eb4aea26b3a (patch) | |
| tree | 100a6334561743a5a27c3d18e376170e6c27a20d /docs/reference/src | |
| parent | a99096840498f367550bde7cb321b8f83b58c559 (diff) | |
| download | nng-399a4cdc7e43354b3d103c68f2115eb4aea26b3a.tar.gz nng-399a4cdc7e43354b3d103c68f2115eb4aea26b3a.tar.bz2 nng-399a4cdc7e43354b3d103c68f2115eb4aea26b3a.zip | |
nng_aleep_aio
Diffstat (limited to 'docs/reference/src')
| -rw-r--r-- | docs/reference/src/SUMMARY.md | 1 | ||||
| -rw-r--r-- | docs/reference/src/api/util/nng_sleep_aio.md | 31 |
2 files changed, 32 insertions, 0 deletions
diff --git a/docs/reference/src/SUMMARY.md b/docs/reference/src/SUMMARY.md index a047101d..0a99d045 100644 --- a/docs/reference/src/SUMMARY.md +++ b/docs/reference/src/SUMMARY.md @@ -97,6 +97,7 @@ - [nng_free](api/util/nng_free.md) - [nng_msleep](api/util/nng_msleep.md) - [nng_random](api/util/nng_random.md) + - [nng_sleep_aio](api/util/nng_sleep_aio.md) - [nng_strdup](api/util/nng_strdup.md) - [nng_strerror](api/util/nng_strerror.md) - [nng_strfree](api/util/nng_strfree.md) diff --git a/docs/reference/src/api/util/nng_sleep_aio.md b/docs/reference/src/api/util/nng_sleep_aio.md new file mode 100644 index 00000000..799f512f --- /dev/null +++ b/docs/reference/src/api/util/nng_sleep_aio.md @@ -0,0 +1,31 @@ +# nng_sleep_aio + +## NAME + +nng_sleep_aio - sleep asynchronously + +## SYNOPSIS + +```c +#include <nng/nng.h> + +void nng_sleep_aio(nng_duration msec, nng_aio *aio); +``` + +## DESCRIPTION + +The `nng_sleep_aio()` function provides an asynchronous delay mechanism, +causing the callback for _aio_ to be executed after _msec_ milliseconds. +If the sleep finishes completely, the result will always be zero. + +> [!NOTE] +> If a timeout is set on _aio_ using +> [`nng_aio_set_timeout()`](../aio/nng_aio_set_timeout.md), and it is shorter +> than _msec_, +> then the sleep will wake up early, with a result code of `NNG_ETIMEDOUT`. + +## SEE ALSO + +[nng_clock](nng_clock.md), +[nng_msleep](nng_msleep.md), +[Asynchronous I/O](../aio/index.md) |