aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_aio_abort.adoc
blob: c3dcc6415c4c98c75b50ede4a3f8875aeab1a9e5 (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
50
51
52
53
54
55
56
57
= nng_aio_abort(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:manvolnum: 3
:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
            Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
            {blank} + \
            This document is supplied under the terms of the \
            https://opensource.org/licenses/MIT[MIT License].

== NAME

nng_aio_abort - abort asynchronous I/O operation

== SYNOPSIS

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

void nng_aio_abort(nng_aio *aio, int err);
-----------


== DESCRIPTION

The `nng_aio_abort()` function aborts an operation previously started
with the handle _aio_.  If the operation is aborted, then the callback
for the handle will be called, and the function
<<nng_aio_result#,nng_aio_result(3)>> will return the error _err_.

This function does not wait for the operation to be fully aborted, but
returns immediately.

If no operation is currently in progress (either because it has already
finished, or no operation has been started yet), then this function
has no effect.

== RETURN VALUES

None.

== ERRORS

None.

== SEE ALSO

<<nng_aio_alloc#,nng_aio_alloc(3)>>,
<<nng_aio_cancel#,nng_aio_cancel(3)>>,
<<nng_aio_result#,nng_aio_result(3)>>,
<<nng#,nng(7)>>

== COPYRIGHT

{copyright}