1= nng_aio_get_msg(3)
2//
3// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
4// Copyright 2018 Capitar IT Group BV <info@capitar.com>
5//
6// This document is supplied under the terms of the MIT License, a
7// copy of which should be located in the distribution where this
8// file was obtained (LICENSE.txt).  A copy of the license may also be
9// found online at https://opensource.org/licenses/MIT.
10//
11
12== NAME
13
14nng_aio_get_msg - get message from asynchronous receive
15
16== SYNOPSIS
17
18[source, c]
19----
20#include <nng/nng.h>
21
22nng_msg *nng_aio_get_msg(nng_aio *aio);
23----
24
25== DESCRIPTION
26
27The `nng_aio_get_msg()` function gets any message stored in _aio_ as
28either a result of a successful receive
29(see xref:nng_recv_aio.3.adoc[`nng_recv_aio()`])
30or that was previously stored with xref:nng_aio_set_msg.3.adoc[`nng_aio_set_msg()`].
31
32IMPORTANT: The xref:nng_aio.5.adoc[`nng_aio`] must not have an operation in progress.
33
34== RETURN VALUES
35
36None.
37
38== ERRORS
39
40None.
41
42== SEE ALSO
43
44[.text-left]
45xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg(3)],
46xref:nng_recv_aio.3.adoc[nng_recv_aio(3)],
47xref:nng_aio.5.adoc[nng_aio(5)],
48xref:nng_msg.5.adoc[nng_msg(5)],
49xref:nng.7.adoc[nng(7)]
50