aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_aio_wait.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-24 22:58:47 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-24 22:58:47 -0700
commit2ac729f333395659c527a21fbcda128b46af7352 (patch)
treeac74c91d043cac21e66e856f73dd4bbd52b2eb64 /docs/man/nng_aio_wait.3.adoc
parent3b1615c0dea75b082b7d27b73fbce65a836a87e2 (diff)
downloadnng-2ac729f333395659c527a21fbcda128b46af7352.tar.gz
nng-2ac729f333395659c527a21fbcda128b46af7352.tar.bz2
nng-2ac729f333395659c527a21fbcda128b46af7352.zip
docs: AIO chapter (consumer only) converted to mdbook.
Diffstat (limited to 'docs/man/nng_aio_wait.3.adoc')
-rw-r--r--docs/man/nng_aio_wait.3.adoc54
1 files changed, 0 insertions, 54 deletions
diff --git a/docs/man/nng_aio_wait.3.adoc b/docs/man/nng_aio_wait.3.adoc
deleted file mode 100644
index acac6fdf..00000000
--- a/docs/man/nng_aio_wait.3.adoc
+++ /dev/null
@@ -1,54 +0,0 @@
-= nng_aio_wait(3)
-//
-// Copyright 2023 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_aio_wait - wait for asynchronous I/O operation
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void nng_aio_wait(nng_aio *aio);
-----
-
-== DESCRIPTION
-
-The `nng_aio_wait()` function waits for an asynchronous I/O operation
-to complete.
-If the operation has not been started, or has already
-completed, then it returns immediately.
-
-If a callback was set with _aio_ when it was allocated, then this
-function will not be called until the callback has completed.
-
-IMPORTANT: This function should never be called from a function that itself
-is a callback of an xref:nng_aio.5.adoc[`aio`], either this one or any other.
-Doing so may result in a deadlock.
-
-== 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_busy.3.adoc[nng_aio_busy(3)],
-xref:nng_aio.5.adoc[nng_aio(5)],
-xref:nng.7.adoc[nng(7)]