man/v1.2/nng_aio_alloc.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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

---
version: v1.2
layout: refman
---
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.10">
<title>nng_aio_alloc(3)</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<link rel="stylesheet" href="./asciidoctor.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
</head>
<body class="manpage toc2 toc-left">
<div id="header">
<h1>nng_aio_alloc(3) Manual Page</h1>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_synopsis">SYNOPSIS</a></li>
<li><a href="#_description">DESCRIPTION</a></li>
<li><a href="#_return_values">RETURN VALUES</a></li>
<li><a href="#_errors">ERRORS</a></li>
<li><a href="#_see_also">SEE ALSO</a></li>
</ul>
</div>
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<p>nng_aio_alloc - allocate asynchronous I/O handle</p>
</div>
</div>
<div id="content">
<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-cpf">&lt;nng/nng.h&gt;</span><span class="tok-cp"></span>

<span class="tok-kt">int</span> <span class="tok-nf">nng_aio_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">**</span><span class="tok-n">aiop</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-p">(</span><span class="tok-o">*</span><span class="tok-n">callb</span><span class="tok-p">)(</span><span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-p">),</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">arg</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_alloc()</code> function allocates a handle for asynchronous I/O
operations, and stores a pointer to it in <em>aiop</em>.
The handle is initialized with a completion callback of <em>callb</em>,
which will be executed when an associated asynchronous operation finishes.
It will be called with the argument <em>arg</em>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
The callback <em>callb</em> must not perform any blocking operations, and
must complete its execution quickly.  If <em>callb</em> does block, this can
lead ultimately to an apparent "hang" or deadlock in the application.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Asynchronous I/O operations all take an <a href="nng_aio.5.html"><code>nng_aio</code></a>
handle such as allocated by this function.
Such operations are usually started by a function that returns immediately.
The operation is then run asynchronously, and completes sometime later.
When that operation is complete, the callback supplied here is called,
and that callback is able to determine the result of the operation using
<a href="nng_aio_result.3.html"><code>nng_aio_result()</code></a>,
<a href="nng_aio_count.3.html"><code>nng_aio_count()</code></a>,
and <a href="nng_aio_get_output.3.html"><code>nng_aio_get_output()</code></a>.</p>
</div>
<div class="paragraph">
<p>It is possible to wait synchronously for an otherwise asynchronous operation
by using the function <a href="nng_aio_wait.3.html"><code>nng_aio_wait()</code></a>.
In that case, it is permissible for <em>callb</em> and <em>arg</em> to both be <code>NULL</code>.
Note that if these are <code>NULL</code>, then it will not be possible to determine when the
operation is complete except by calling the aforementioned
<a href="nng_aio_wait.3.html"><code>nng_aio_wait()</code></a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This function returns 0 on success, and non-zero otherwise.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
<code>NNG_ENOMEM</code>
</td>
<td class="hdlist2">
<p>Insufficient free memory to perform the operation.</p>
</td>
</tr>
</table>
</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_abort.3.html">nng_aio_abort(3)</a>,
<a href="nng_aio_cancel.3.html">nng_aio_cancel(3)</a>,
<a href="nng_aio_count.3.html">nng_aio_count(3)</a>,
<a href="nng_aio_free.3.html">nng_aio_free(3)</a>,
<a href="nng_aio_get_input.3.html">nng_aio_get_input(3)</a>,
<a href="nng_aio_get_msg.3.html">nng_aio_get_msg(3)</a>,
<a href="nng_aio_get_output.3.html">nng_aio_get_output(3)</a>,
<a href="nng_aio_result.3.html">nng_aio_result(3)</a>,
<a href="nng_aio_set_input.3.html">nng_aio_set_input(3)</a>,
<a href="nng_aio_set_iov.3.html">nng_aio_set_iov(3)</a>,
<a href="nng_aio_set_msg.3.html">nng_aio_set_msg(3)</a>,
<a href="nng_aio_set_timeout.3.html">nng_aio_set_timeout(3)</a>,
<a href="nng_aio_stop.3.html">nng_aio_stop(3)</a>,
<a href="nng_aio_wait.3.html">nng_aio_wait(3)</a>,
<a href="nng_strerror.3.html">nng_strerror(3)</a>,
<a href="nng_aio.5.html">nng_aio(5)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>
</div>
<link rel="stylesheet" href="./pygments-default.css">
</body>
</html>