diff options
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/aio/nng_sleep_aio.adoc | 27 | ||||
| -rw-r--r-- | docs/ref/old/nng_ctx_getopt.adoc (renamed from docs/ref/ctx/nng_ctx_getopt.adoc) | 0 | ||||
| -rw-r--r-- | docs/ref/old/nng_ctx_setopt.adoc (renamed from docs/ref/ctx/nng_ctx_setopt.adoc) | 0 |
3 files changed, 27 insertions, 0 deletions
diff --git a/docs/ref/aio/nng_sleep_aio.adoc b/docs/ref/aio/nng_sleep_aio.adoc new file mode 100644 index 00000000..f2ecd288 --- /dev/null +++ b/docs/ref/aio/nng_sleep_aio.adoc @@ -0,0 +1,27 @@ +## 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. + +### Errors + +[horizontal] +`NNG_ETIMEDOUT`:: The sleep was interrupted by a timeout.footnote:[This seemingly paradoxical situation happens if the _aio_ has a timeout set with xref:nng_aio_set_timeout.adoc[`nng_aio_set_timeout`] that is shorter than _msec_.] +`NNG_ECANCELED`:: The operation was canceled. + +### See Also + +xref:nng_aio_abort.adoc[nng_aio_abort], +xref:nng_aio_set_timeout.adoc[nng_aio_set_timeout]
\ No newline at end of file diff --git a/docs/ref/ctx/nng_ctx_getopt.adoc b/docs/ref/old/nng_ctx_getopt.adoc index cd9dfd53..cd9dfd53 100644 --- a/docs/ref/ctx/nng_ctx_getopt.adoc +++ b/docs/ref/old/nng_ctx_getopt.adoc diff --git a/docs/ref/ctx/nng_ctx_setopt.adoc b/docs/ref/old/nng_ctx_setopt.adoc index df6eda4d..df6eda4d 100644 --- a/docs/ref/ctx/nng_ctx_setopt.adoc +++ b/docs/ref/old/nng_ctx_setopt.adoc |