summaryrefslogtreecommitdiff
path: root/docs/man/nng_aio_get_msg.3.adoc
blob: 4ae1c38bb6c6a57e2bab7c1453faf7720acca9d4 (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
= nng_aio_get_msg(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_get_msg - get message from asynchronous receive

== SYNOPSIS

[source, c]
----
#include <nng/nng.h>

nng_msg *nng_aio_get_msg(nng_aio *aio);
----

== DESCRIPTION

The `nng_aio_get_msg()` function gets any message stored in _aio_ as
either a result of a successful receive
(see <<nng_recv_aio.3#,`nng_recv_aio()`>>)
or that was previously stored with <<nng_aio_set_msg.3#,`nng_aio_set_msg()`>>.

IMPORTANT: The `nng_aio` must not have an operation in progress.

== RETURN VALUES

None.

== ERRORS

None.

== SEE ALSO

<<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>,
<<nng_recv_aio.3#,nng_recv_aio(3)>>,
<<nng_aio.5#,nng_aio(5)>>,
<<nng_msg.5#,nng_msg(5)>>,
<<nng.7#,nng(7)>>