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
58
59
60
|
= nng_aio_stop(3)
//
// Copyright 2024 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_stop - stop asynchronous I/O operation
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
void nng_aio_stop(nng_aio *aio);
----
== DESCRIPTION
The `nng_aio_stop()` function stops the asynchronous I/O operation
associated with _aio_ by aborting with `NNG_ECANCELED`, and then waits
for it to complete or to be completely aborted, and for the
callback associated with the _aio_ to have completed executing.
Further calls to
xref:nng_aio_begin.3.adoc[`nng_aio_begin()`] using this _aio_ will return false.
It is safe to call this for an _aio_, even when no operation is currently
pending for it.
TIP: When multiple asynchronous I/O handles are in use and need to be
shut down, it is safest to stop all of them, before deallocating any of
them with xref:nng_aio_free.3.adoc[`nng_aio_free()`], particularly if the callbacks
might attempt to reschedule additional operations.
== RETURN VALUES
None.
== ERRORS
None.
== SEE ALSO
[.text-left]
xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)],
xref:nng_aio_free.3.adoc[nng_aio_free(3)],
xref:nng_aio_begin.3.adoc[nng_aio_begin(3)],
xref:nng_aio_wait.3.adoc[nng_aio_wait(3)],
xref:nng_aio.5.adoc[nng_aio(5)],
xref:nng.7.adoc[nng(7)]
|
