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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
---
version: v1.2.4
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_socket_get(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_socket_get(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>
<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_socket_get - get socket option</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_socket_get</span><span class="tok-p">(</span><span class="tok-n">nng_socket</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">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_bool</span><span class="tok-p">(</span><span class="tok-n">nng_socket</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-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_int</span><span class="tok-p">(</span><span class="tok-n">nng_socket</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-o">*</span><span class="tok-n">ivalp</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_socket</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-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_socket</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-o">*</span><span class="tok-n">u64p</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_string</span><span class="tok-p">(</span><span class="tok-n">nng_socket</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">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_socket</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">ptr</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_ms</span><span class="tok-p">(</span><span class="tok-n">nng_socket</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-o">*</span><span class="tok-n">durp</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_socket_get_addr</span><span class="tok-p">(</span><span class="tok-n">nng_socket</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_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">addrp</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_socket_get()</code> functions are used to retrieve option values for
the <a href="nng_socket.5.html">socket</a> <em>s</em>.
The actual options that may be retrieved in this way vary.
A number of them are documented in <a href="nng_options.5.html">nng_options(5)</a>.</p>
</div>
<div class="paragraph">
<p>Additionally transport-specific options 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>In all of these forms, the option <em>opt</em> is retrieved from the socket <em>s</em>.
The forms vary based on the type of the option they take.</p>
</div>
<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_socket_get()</code></dt>
<dd>
<p>This function is untyped and can be used to retrieve the value of any option.
The caller must store a pointer to a buffer to receive the value in <em>val</em>,
and the size of the buffer shall be stored at the location referenced by
<em>valszp</em>.</p>
<div class="paragraph">
<p>When the function returns, the actual size of the data copied (or that
would have been copied if sufficient space were present) is stored at
the location referenced by <em>valszp</em>.
If the caller’s buffer is not large enough to hold the entire object,
then the copy is truncated.
Therefore the caller should check for truncation by verifying that the
returned size in <em>valszp</em> does not exceed the original buffer size.</p>
</div>
<div class="paragraph">
<p>It is acceptable to pass <code>NULL</code> for <em>val</em> if the value in <em>valszp</em> is zero.
This can be used to determine the size of the buffer needed to receive
the object.</p>
</div>
<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_socket_get_bool()</code></dt>
<dd>
<p>This function is for options which take a Boolean (<code>bool</code>).
The value will be stored at <em>bvalp</em>.</p>
</dd>
<dt class="hdlist1"><code>nng_socket_get_int()</code></dt>
<dd>
<p>This function is for options which take an integer (<code>int</code>).
The value will be stored at <em>ivalp</em>.</p>
</dd>
<dt class="hdlist1"><code>nng_socket_get_ms()</code></dt>
<dd>
<p>This function is used to retrieve time <a href="nng_duration.5.html">durations</a>
(such as timeouts), stored in <em>durp</em> as a number of milliseconds.
(The special value <code>NNG_DUR_INFINITE</code> means an infinite amount of time, and
the special value <code>NNG_DUR_DEFAULT</code> means a context-specific default.)</p>
</dd>
<dt class="hdlist1"><code>nng_socket_get_ptr()</code></dt>
<dd>
<p>This function is used to retrieve a pointer, <em>ptr</em>, to structured data.
The data referenced by <em>ptr</em> is generally managed using other functions.
Note that this form is somewhat special in that the object is generally
not copied, but instead the <strong>pointer</strong> to the object is copied.</p>
</dd>
<dt class="hdlist1"><code>nng_socket_get_size()</code></dt>
<dd>
<p>This function is used to retrieve a size into the pointer <em>zp</em>,
typically for buffer sizes, message maximum sizes, and similar options.</p>
</dd>
<dt class="hdlist1"><code>nng_socket_get_string()</code></dt>
<dd>
<p>This function is used to retrieve a string into <em>strp</em>.
This string is created from the source using <a href="nng_strdup.3.html"><code>nng_strdup()</code></a>
and consequently must be freed by the caller using
<a href="nng_strfree.3.html"><code>nng_strfree()</code></a> when it is no longer needed.</p>
</dd>
<dt class="hdlist1"><code>nng_socket_get_uint64()</code></dt>
<dd>
<p>This function is used to retrieve a 64-bit unsigned value into the value
referenced by <em>u64p</em>.
This is typically used for options related to identifiers, network
numbers, and similar.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>These functions return 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_EBADTYPE</code>
</td>
<td class="hdlist2">
<p>Incorrect type for option.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ECLOSED</code>
</td>
<td class="hdlist2">
<p>Parameter <em>s</em> does not refer to an open socket.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EINVAL</code>
</td>
<td class="hdlist2">
<p>Size of destination <em>val</em> too small for object.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOMEM</code>
</td>
<td class="hdlist2">
<p>Insufficient memory exists.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOTSUP</code>
</td>
<td class="hdlist2">
<p>The option <em>opt</em> is not supported.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EWRITEONLY</code>
</td>
<td class="hdlist2">
<p>The option <em>opt</em> is write-only.</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_dialer_get.3.html">nng_dialer_get(3)</a>,
<a href="nng_listener_get.3.html">nng_listener_get(3)</a>,
<a href="nng_pipe_get.3.html">nng_pipe_get(3)</a>,
<a href="nng_socket_set.3.html">nng_socket_set(3)</a>,
<a href="nng_strdup.3.html">nng_strdup(3)</a>,
<a href="nng_strerror.3.html">nng_strerror(3)</a>,
<a href="nng_strfree.3.html">nng_strfree(3)</a>,
<a href="nng_duration.5.html">nng_duration(5)</a>,
<a href="nng_options.5.html">nng_options(5)</a>,
<a href="nng_socket.5.html">nng_socket(5)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>
</div>
<link rel="stylesheet" href="./pygments-default.css">
</body>
</html>
|
