man/tip/nng_iov.5.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

---
version: tip
layout: manpage_v2
title: nng_iov(5)
---
<h1>nng_iov(5)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_iov - scatter/gather element</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-k">typedef</span><span class="tok-w"> </span><span class="tok-k">struct</span><span class="tok-w"> </span><span class="tok-p">{</span>
<span class="tok-w">    </span><span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-w"> </span><span class="tok-n">iov_buf</span><span class="tok-p">;</span>
<span class="tok-w">    </span><span class="tok-kt">size_t</span><span class="tok-w"> </span><span class="tok-n">iov_len</span><span class="tok-p">;</span>
<span class="tok-p">}</span><span class="tok-w"> </span><span class="tok-n">nng_iov</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>An <code>nng_iov</code> structure represents a single element in a scatter/gather
array.
Some operations can use arrays of these to access different regions of
memory in a single operation.
For example, it may be useful to send a message with header data from
one part of memory, and a user payload from another.</p>
</div>
<div class="paragraph">
<p>The operations that do this typically store an array of these in
an <a href="nng_aio.5.html"><code>nng_aio</code></a> structure using the
<a href="nng_aio_set_iov.3.html"><code>nng_aio_set_iov()</code></a> function.</p>
</div>
<div class="paragraph">
<p>The following structure members are present:</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>iov_buf</code></dt>
<dd>
<p>This is a pointer to the first byte within the memory being
referenced by this scatter/gather element.</p>
</dd>
<dt class="hdlist1"><code>iov_len</code></dt>
<dd>
<p>This is the size in bytes of this scatter/gather element.</p>
</dd>
</dl>
</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_set_iov.3.html">nng_aio_set_iov(3)</a>,
<a href="nng_aio.5.html">nng_aio(5)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>