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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
---
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_stream_set(3str)</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_stream_set(3str) 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>
<ul class="sectlevel2">
<li><a href="#_forms">Forms</a></li>
</ul>
</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_stream_set - set option on byte stream</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"><nng/nng.h></span><span class="tok-cp"></span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">name</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">data</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">size</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_bool</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-n">val</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_int</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">val</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_ms</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_duration</span> <span class="tok-n">val</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">val</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_size</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-n">val</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_string</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">val</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">val</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_set_addr</span><span class="tok-p">(</span><span class="tok-n">nng_stream</span> <span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">val</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_set()</code> functions are used to configure options for the
<a href="nng_stream.5.html">byte stream</a> <em>s</em>.
The actual options that may be configured in this way vary, and are
specified by <em>opt</em>.
A number of them are documented in
<a href="nng_options.5.html">nng_options(5)</a>.</p>
</div>
<div class="paragraph">
<p>Additionally some transport-specific and protocol-specific options are
documented with the transports and protocols themselves.</p>
</div>
<div class="sect2">
<h3 id="_forms">Forms</h3>
<div class="paragraph">
<p>The details of the type, size, and semantics of the option will depend
on the actual option, and will be documented with the option itself.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>nng_stream_set()</code></dt>
<dd>
<p>This function is untyped, and can be used to configure any arbitrary data.
The <em>val</em> pointer addresses the data to copy, and <em>size</em> is the
size of the objected located at <em>val</em>.</p>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
It may be easier to use one of the typed forms of this function.
</td>
</tr>
</table>
</div>
</dd>
<dt class="hdlist1"><code>nng_stream_set_bool()</code></dt>
<dd>
<p>This function is for options which take a Boolean (<code>bool</code>).</p>
</dd>
<dt class="hdlist1"><code>nng_stream_set_int()</code></dt>
<dd>
<p>This function is for options which take an integer (<code>int</code>).</p>
</dd>
<dt class="hdlist1"><code>nng_stream_set_ms()</code></dt>
<dd>
<p>This function is used to configure time durations (such as timeouts) using
the type
<a href="nng_duration.5.html"><code>nng_duration</code></a>.
The duration is an integer number of milliseconds.</p>
</dd>
<dt class="hdlist1"><code>nng_stream_set_ptr()</code></dt>
<dd>
<p>This function is used to pass a pointer to structured data.
The data referenced by is generally managed by other functions.
For example, TLS configuration objects created with
<a href="nng_tls_config.3tls.html"><code>nng_tls_config_alloc()</code></a>
can be passed this way.</p>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
This form is somewhat special in that the object is generally
not copied, but instead the <strong>pointer</strong> to the object is copied.
Please see the documentation for the specific option for further details.
</td>
</tr>
</table>
</div>
</dd>
<dt class="hdlist1"><code>nng_stream_set_size()</code></dt>
<dd>
<p>This function is used to configure a size, typically for buffer sizes,
message maximum sizes, and similar options.</p>
</dd>
<dt class="hdlist1"><code>nng_stream_set_string()</code></dt>
<dd>
<p>This function is used to pass configure a string.
Strings passed this way must be legal UTF-8 or ASCII strings, terminated
with a <code>NUL</code> (<code>\0</code>) byte.
(Other constraints may apply as well, see the documentation for each option
for details.)</p>
</dd>
<dt class="hdlist1"><code>nng_stream_set_uint64()</code></dt>
<dd>
<p>This function is used to configure a 64-bit unsigned value/
This is typically used for identifiers, network numbers,
and similar options.</p>
</dd>
<dt class="hdlist1"><code>nng_stream_set_addr()</code></dt>
<dd>
<p>This function is used to configure a
<a href="nng_sockaddr.5.html">socket address</a>.
The value is copied, and thus the caller may discard the supplied
value immediately after this function returns.</p>
</dd>
</dl>
</div>
</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_ECLOSED</code>
</td>
<td class="hdlist2">
<p>The connection is closed.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EINVAL</code>
</td>
<td class="hdlist2">
<p>Either <em>data</em> or <em>size</em> are invalid.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOTSUP</code>
</td>
<td class="hdlist2">
<p>The option is not supported.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EREADONLY</code>
</td>
<td class="hdlist2">
<p>The option may not be modified.</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_strerror.3.html">nng_strerror(3)</a>,
<a href="nng_stream_get.3str.html">nng_stream_get(3str)</a>,
<a href="nng_options.5.html">nng_options(5)</a>,
<a href="nng_ipc_options.5.html">nng_ipc_options(5)</a>,
<a href="nng_tcp_options.5.html">nng_tcp_options(5)</a>,
<a href="nng_tls_options.5.html">nng_tls_options(5)</a>,
<a href="nng_stream.5.html">nng_stream(5)</a></p>
</div>
</div>
</div>
</div>
<link rel="stylesheet" href="./pygments-default.css">
</body>
</html>
|
