summaryrefslogtreecommitdiff
path: root/docs/reference/src/util/nng_sleep_aio.md
blob: 7092fa3a9febfed73e35cda46b5ec7ed29599b26 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# 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],
[nng_msleep][nng_msleep],
[Asynchronous I/O](../aio/index.md)

{{#include ../refs.md}}