summaryrefslogtreecommitdiff
path: root/docs/man/nng_aio_wait.3.adoc
blob: 5b65c79e0dc6660e9b917858368ed8c0b609d47b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
= nng_aio_wait(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_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 the a callback was set with _aio_ when it was allocated, then this
function will not be called until the callback has completed.

== 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.5.adoc[nng_aio(5)],
xref:nng.7.adoc[nng(7)]