diff options
Diffstat (limited to 'docs/man/nng_sleep_aio.adoc')
| -rw-r--r-- | docs/man/nng_sleep_aio.adoc | 48 |
1 files changed, 0 insertions, 48 deletions
diff --git a/docs/man/nng_sleep_aio.adoc b/docs/man/nng_sleep_aio.adoc deleted file mode 100644 index 8181046d..00000000 --- a/docs/man/nng_sleep_aio.adoc +++ /dev/null @@ -1,48 +0,0 @@ -= 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. -If the sleep finishes completely, the result will always be zero. - -NOTE: If a timeout is set on _aio_ using -<<nng_aio_timeout#,nng_aio_set_timeout(3)>>, and it is shorter than _msec_, -then the sleep will wake up early, with a result code of `NNG_ETIMEDOUT`. - -== 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)>> |