aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_sleep_aio.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-27 11:11:11 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-27 11:11:11 -0700
commit8e2a09468f57f75cefcd61fd73e647efdc3621dc (patch)
tree190fdd70292589dfca76814c8bd78eb5c2584f06 /docs/man/nng_sleep_aio.3.adoc
parent2ac729f333395659c527a21fbcda128b46af7352 (diff)
downloadnng-8e2a09468f57f75cefcd61fd73e647efdc3621dc.tar.gz
nng-8e2a09468f57f75cefcd61fd73e647efdc3621dc.tar.bz2
nng-8e2a09468f57f75cefcd61fd73e647efdc3621dc.zip
docs: update nng_sleep_aio for mdbook
Diffstat (limited to 'docs/man/nng_sleep_aio.3.adoc')
-rw-r--r--docs/man/nng_sleep_aio.3.adoc53
1 files changed, 0 insertions, 53 deletions
diff --git a/docs/man/nng_sleep_aio.3.adoc b/docs/man/nng_sleep_aio.3.adoc
deleted file mode 100644
index 2a3cf4f2..00000000
--- a/docs/man/nng_sleep_aio.3.adoc
+++ /dev/null
@@ -1,53 +0,0 @@
-= nng_sleep_aio(3)
-//
-// Copyright 2020 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 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
-xref:nng_aio_set_timeout.3.adoc[`nng_aio_set_timeout()`], 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
-
-[.text-left]
-xref:nng_aio_abort.3.adoc[nng_aio_abort(3)],
-xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
-xref:nng_aio_set_timeout.3.adoc[nng_aio_set_timeout(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_aio.5.adoc[nng_aio(5)],
-xref:nng_duration.5.adoc[nng_duration(5)],
-xref:nng.7.adoc[nng(7)]