diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-03-12 15:13:47 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-03-12 15:13:47 -0700 |
| commit | 2f1e799d1225b18e960d426d35b6a83fa80db86f (patch) | |
| tree | f02c8fb94ede04586e005cc8905ba6ccae740a5d /docs | |
| parent | 6ae722de957b33a3520e46a94bb1f970991a9a42 (diff) | |
| download | nng-2f1e799d1225b18e960d426d35b6a83fa80db86f.tar.gz nng-2f1e799d1225b18e960d426d35b6a83fa80db86f.tar.bz2 nng-2f1e799d1225b18e960d426d35b6a83fa80db86f.zip | |
fixes #281 desire nng_sleep_aio()
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/libnng.adoc | 1 | ||||
| -rw-r--r-- | docs/man/nng_sleep_aio.adoc | 49 |
2 files changed, 50 insertions, 0 deletions
diff --git a/docs/man/libnng.adoc b/docs/man/libnng.adoc index 8c18c8ff..68cbdcf4 100644 --- a/docs/man/libnng.adoc +++ b/docs/man/libnng.adoc @@ -157,6 +157,7 @@ The following functions are used in the asynchronous model: |<<nng_aio_wait#,nng_aio_wait(3)>>|wait for asynchronous I/O operation |<<nng_recv_aio#,nng_recv_aio(3)>>|receive message asynchronously |<<nng_send_aio#,nng_send_aio(3)>>|send message asynchronously +|<<nng_sleep_aio#,nng_sleep_aio(3)>>|sleep asynchronously |=== === Protocols diff --git a/docs/man/nng_sleep_aio.adoc b/docs/man/nng_sleep_aio.adoc new file mode 100644 index 00000000..dff00219 --- /dev/null +++ b/docs/man/nng_sleep_aio.adoc @@ -0,0 +1,49 @@ += nng_sleep_aio(3) +// +// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// This document is supplied under the terms of the MIT License, a +// copy of which should be located in the distribution where this +// file was obtained (LICENSE.txt). A copy of the license may also be +// found online at https://opensource.org/licenses/MIT. +// + +== NAME + +nng_sleep_aio - sleep asynchronously + +== SYNOPSIS + +[source, c] +----------- +#include <nng/nng.h> + +void nng_sleep_aio(nng_duration msec, nng_aio *aio); +----------- + +== DESCRIPTION + +The `nng_sleep_aio()` function performs an asynchronous "`sleep``", +causing the callback for _aio_ to be executed after _msec_ milliseconds. +This is logically the equivalent of starting an asynchronous operation +that does nothing at all, but expires after _msec_ duration, _except_ that +the completion result will be zero rather `NNG_ETIMEDOUT`. + +NOTE: This overrides and replaces any timeout on the _aio_ set with +<<nng_aio_set_timeout#,nng_aio_set_timeout(3)>>. + +== RETURN VALUES + +None. + +== ERRORS + +None. + +== SEE ALSO + +<<nng_aio_abort#,nng_aio_abort(3)>>, +<<nng_aio_alloc#,nng_aio_alloc(3)>>, +<<nng_aio_set_timeout#,nng_aio_set_timeout(3)>>, +<<nng#,nng(7)>> |