1= nng_aio_abort(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_abort - abort asynchronous I/O operation
15
16== SYNOPSIS
17
18[source, c]
19----
20#include <nng/nng.h>
21
22void nng_aio_abort(nng_aio *aio, int err);
23----
24
25== DESCRIPTION
26
27The `nng_aio_abort()` function aborts an operation previously started
28with the handle _aio_.
29If the operation is aborted, then the callback
30for the handle will be called, and the function
31xref:nng_aio_result.3.adoc[`nng_aio_result()`] will return the error _err_.
32
33This function does not wait for the operation to be fully aborted, but
34returns immediately.
35
36If no operation is currently in progress (either because it has already
37finished, or no operation has been started yet), then this function
38has no effect.
39
40== RETURN VALUES
41
42None.
43
44== ERRORS
45
46None.
47
48== SEE ALSO
49
50[.text-left]
51xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
52xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)],
53xref:nng_aio_result.3.adoc[nng_aio_result(3)],
54xref:nng_aio.5.adoc[nng_aio(5)],
55xref:nng.7.adoc[nng(7)]
56