man/tip/nng_aio_stop.3.html


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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

---
version: tip
layout: manpage_v2
title: nng_aio_stop(3)
---
<h1>nng_aio_stop(3)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_aio_stop - stop asynchronous I/O operation</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-cp">#include</span><span class="tok-w"> </span><span class="tok-cpf">&lt;nng/nng.h&gt;</span>

<span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-nf">nng_aio_stop</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>nng_aio_stop()</code> function stops the asynchronous I/O operation
associated with <em>aio</em> by aborting with <code>NNG_ECANCELED</code>, and then waits
for it to complete or to be completely aborted, and for the
callback associated with the <em>aio</em> to have completed executing.</p>
</div>
<div class="paragraph">
<p>Further calls to
<a href="nng_aio_begin.3.html"><code>nng_aio_begin()</code></a> using this <em>aio</em> will return false.</p>
</div>
<div class="paragraph">
<p>It is safe to call this for an <em>aio</em>, even when no operation is currently
pending for it.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
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 <a href="nng_aio_free.3.html"><code>nng_aio_free()</code></a>, particularly if the callbacks
might attempt to reschedule additional operations.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph text-left">
<p><a href="nng_aio_alloc.3.html">nng_aio_alloc(3)</a>,
<a href="nng_aio_cancel.3.html">nng_aio_cancel(3)</a>,
<a href="nng_aio_free.3.html">nng_aio_free(3)</a>,
<a href="nng_aio_begin.3.html">nng_aio_begin(3)</a>,
<a href="nng_aio_wait.3.html">nng_aio_wait(3)</a>,
<a href="nng_aio.5.html">nng_aio(5)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>