git-subtree-dir: external/nng git-subtree-split: 29b73962b939a6fbbf6ea8d5d7680bb06d0eeb99
54 lines
1.3 KiB
Text
54 lines
1.3 KiB
Text
= 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)]
|