summaryrefslogtreecommitdiff
path: root/docs/reference/src/aio/nng_aio_result.md
blob: 16cede6a4aaf09d882b7dd1aa8fd11a1beb6d7cc (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_result

## NAME

nng_aio_result --- return result of asynchronous operation

## SYNOPSIS

```c
#include <nng/nng.h>

int nng_aio_result(nng_aio *aio);
```

## DESCRIPTION

The `nng_aio_result()` returns the result of the operation associated
with the handle _aio_.
If the operation was successful, then 0 is returned.
Otherwise a non-zero error code is returned.

> [!NOTE]
> The return value from this function is undefined if the operation
> has not completed yet.
> Either call this from the handle's completion
> callback, or after waiting for the operation to complete with
> [`nng_aio_wait()`][nng_aio_wait].

## RETURN VALUES

The result of the operation, either zero on success, or an error
number on failure.

## ERRORS

- `NNG_ETIMEDOUT`: The operation timed out.
- `NNG_ECANCELED`: The operation was canceled.

Various other return values are possible depending on the operation.

## SEE ALSO

[nng_aio_abort][nng_aio_abort],
[nng_aio_alloc][nng_aio_alloc],
[nng_aio_wait][nng_aio_wait],
[nng_strerror](../util/nng_strerror.md)

{{#include ../refs.md}}