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
146
|
---
version: tip
layout: manpage_v2
title: nng_stream_send(3str)
---
<h1>nng_stream_send(3str)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_stream_send - send to byte stream</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"><nng/nng.h></span>
<span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-nf">nng_stream_send</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span><span class="tok-w"> </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_stream_send()</code> function starts an asynchronous send over the
<a href="nng_stream.5.html">byte stream</a> <em>s</em>
from the scatter/gather vector located in the
asynchronous I/O structure <em>aio</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
<a href="nng_aio_set_iov.3.html"><code>nng_aio_set_iov()</code></a>
function must have been
called first, to set the scatter/gather vector for <em>aio</em>.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>This function returns immediately, with no return value.
Completion of the operation is signaled via the <em>aio</em>, and the final
result may be obtained via
<a href="nng_aio_result.3.html"><code>nng_aio_result()</code></a>.
That result will either be zero or an error code.</p>
</div>
<div class="paragraph">
<p>The I/O operation completes as soon as at least one byte has been
sent, or an error has occurred.
Therefore, the number of bytes sent may be less than requested.
The actual number of bytes sent can be determined with
<a href="nng_aio_count.3.html"><code>nng_aio_count()</code></a>.</p>
</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="hdlist">
<table>
<tr>
<td class="hdlist1">
<code>NNG_ECANCELED</code>
</td>
<td class="hdlist2">
<p>The operation was canceled.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ECLOSED</code>
</td>
<td class="hdlist2">
<p>The connection was closed.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ECONNRESET</code>
</td>
<td class="hdlist2">
<p>The peer closed the connection.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EINVAL</code>
</td>
<td class="hdlist2">
<p>The <em>aio</em> does not contain a valid scatter/gather vector.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOMEM</code>
</td>
<td class="hdlist2">
<p>Insufficient free memory to perform the operation.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ETIMEDOUT</code>
</td>
<td class="hdlist2">
<p>Timeout waiting for data from the connection.</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_alloc.3.html">nng_aio_alloc(3)</a>,
<a href="nng_aio_count.3.html">nng_aio_count(3)</a>,
<a href="nng_aio_result.3.html">nng_aio_result(3)</a>,
<a href="nng_aio_set_iov.3.html">nng_aio_set_iov(3)</a>,
<a href="nng_strerror.3.html">nng_strerror(3)</a>,
<a href="nng_stream_close.3str.html">nng_stream_close(3str)</a>,
<a href="nng_stream_recv.3str.html">nng_stream_recv(3str)</a>,
<a href="nng_stream.5.html">nng_stream(5)</a></p>
</div>
</div>
</div>
|
