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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 319959 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-get-option">
<refnamediv>
<refname>socket_get_option</refname>
<refpurpose>Gets socket options for the socket </refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>socket_get_option</methodname>
<methodparam><type>resource</type><parameter>socket</parameter></methodparam>
<methodparam><type>int</type><parameter>level</parameter></methodparam>
<methodparam><type>int</type><parameter>optname</parameter></methodparam>
</methodsynopsis>
<para>
The <function>socket_get_option</function> function retrieves the value for
the option specified by the <parameter>optname</parameter> parameter for the
specified <parameter>socket</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>socket</parameter></term>
<listitem>
<para>
A valid socket resource created with <function>socket_create</function>
or <function>socket_accept</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>level</parameter></term>
<listitem>
<para>
The <parameter>level</parameter> parameter specifies the protocol
level at which the option resides. For example, to retrieve options at
the socket level, a <parameter>level</parameter> parameter of
<constant>SOL_SOCKET</constant> would be used. Other levels, such as
<constant>TCP</constant>, can be used by
specifying the protocol number of that level. Protocol numbers can be
found by using the <function>getprotobyname</function> function.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>optname</parameter></term>
<listitem>
<table>
<title>Available Socket Options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Option</entry>
<entry>Description</entry>
<entry>Type</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>SO_DEBUG</constant></entry>
<entry>
Reports whether debugging information is being recorded.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry><constant>SO_BROADCAST</constant></entry>
<entry>
Reports whether transmission of broadcast messages is supported.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry><constant>SO_REUSEADDR</constant></entry>
<entry>
Reports whether local addresses can be reused.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry><constant>SO_KEEPALIVE</constant></entry>
<entry>
Reports whether connections are kept active with periodic transmission
of messages. If the connected socket fails to respond to these messages,
the connection is broken and processes writing to that socket are notified
with a SIGPIPE signal.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry><constant>SO_LINGER</constant></entry>
<entry>
<para>
Reports whether the <parameter>socket</parameter> lingers on
<function>socket_close</function> if data is present. By default,
when the socket is closed, it attempts to send all unsent data.
In the case of a connection-oriented socket,
<function>socket_close</function> will wait for its peer to
acknowledge the data.
</para>
<para>
If <varname>l_onoff</varname> is non-zero and
<varname>l_linger</varname> is zero, all the
unsent data will be discarded and RST (reset) is sent to the
peer in the case of a connection-oriented socket.
</para>
<para>
On the other hand, if <varname>l_onoff</varname> is
non-zero and <varname>l_linger</varname> is non-zero,
<function>socket_close</function> will block until all the data
is sent or the time specified in <varname>l_linger</varname>
elapses. If the socket is non-blocking,
<function>socket_close</function> will fail and return an error.
</para>
</entry>
<entry>
<type>array</type>. The array will contain two keys:
<varname>l_onoff</varname> and
<varname>l_linger</varname>.
</entry>
</row>
<row>
<entry><constant>SO_OOBINLINE</constant></entry>
<entry>
Reports whether the <parameter>socket</parameter> leaves out-of-band data inline.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry><constant>SO_SNDBUF</constant></entry>
<entry>
Reports the size of the send buffer.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry><constant>SO_RCVBUF</constant></entry>
<entry>
Reports the size of the receive buffer.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry><constant>SO_ERROR</constant></entry>
<entry>
Reports information about error status and clears it.
</entry>
<entry>
<type>int</type> (cannot be set by <function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>SO_TYPE</constant></entry>
<entry>
Reports the <parameter>socket</parameter> type (e.g.
<constant>SOCK_STREAM</constant>).
</entry>
<entry>
<type>int</type> (cannot be set by <function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>SO_DONTROUTE</constant></entry>
<entry>
Reports whether outgoing messages bypass the standard routing facilities.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry><constant>SO_RCVLOWAT</constant></entry>
<entry>
Reports the minimum number of bytes to process for <parameter>socket</parameter>
input operations.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry><constant>SO_RCVTIMEO</constant></entry>
<entry>
Reports the timeout value for input operations.
</entry>
<entry>
<type>array</type>. The array will contain two keys:
<varname>sec</varname> which is the seconds part on the timeout
value and <varname>usec</varname> which is the microsecond part
of the timeout value.
</entry>
</row>
<row>
<entry><constant>SO_SNDTIMEO</constant></entry>
<entry>
Reports the timeout value specifying the amount of time that an output
function blocks because flow control prevents data from being sent.
</entry>
<entry>
<type>array</type>. The array will contain two keys:
<varname>sec</varname> which is the seconds part on the timeout
value and <varname>usec</varname> which is the microsecond part
of the timeout value.
</entry>
</row>
<row>
<entry><constant>SO_SNDLOWAT</constant></entry>
<entry>
Reports the minimum number of bytes to process for <parameter>socket</parameter> output operations.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry><constant>TCP_NODELAY</constant></entry>
<entry>
Reports whether the Nagle TCP algorithm is disabled.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry><constant>MCAST_JOIN_GROUP</constant></entry>
<entry>
Joins a multicast group. (added in PHP 5.4)
</entry>
<entry>
<type>array</type> with keys <literal>"group"</literal>, specifying
a <type>string</type> with an IPv4 or IPv6 multicast address and
<literal>"interface"</literal>, specifying either an interface
number (type <type>int</type>) or a <literal>string</literal> with
the interface name, like <literal>"eth0"</literal>.
<literal>0</literal> can be specified to indicate the interface
should be selected using routing rules. (can only be used in
<function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>MCAST_LEAVE_GROUP</constant></entry>
<entry>
Leaves a multicast group. (added in PHP 5.4)
</entry>
<entry>
<type>array</type>. See <constant>MCAST_JOIN_GROUP</constant> for
more information. (can only be used in
<function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>MCAST_BLOCK_SOURCE</constant></entry>
<entry>
Blocks packets arriving from a specific source to a specific
multicast group, which must have been previously joined.
(added in PHP 5.4)
</entry>
<entry>
<type>array</type> with the same keys as
<constant>MCAST_JOIN_GROUP</constant>, plus one extra key,
<literal>source</literal>, which maps to a <type>string</type>
specifying an IPv4 or IPv6 address of the source to be blocked.
(can only be used in <function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>MCAST_UNBLOCK_SOURCE</constant></entry>
<entry>
Unblocks (start receiving again) packets arriving from a specific
source address to a specific multicast group, which must have been
previously joined. (added in PHP 5.4)
</entry>
<entry>
<type>array</type> with the same format as
<constant>MCAST_BLOCK_SOURCE</constant>.
(can only be used in <function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>MCAST_JOIN_SOURCE_GROUP</constant></entry>
<entry>
Receive packets destined to a specific multicast group whose source
address matches a specific value. (added in PHP 5.4)
</entry>
<entry>
<type>array</type> with the same format as
<constant>MCAST_BLOCK_SOURCE</constant>.
(can only be used in <function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>MCAST_LEAVE_SOURCE_GROUP</constant></entry>
<entry>
Stop receiving packets destined to a specific multicast group whose
soure address matches a specific value. (added in PHP 5.4)
</entry>
<entry>
<type>array</type> with the same format as
<constant>MCAST_BLOCK_SOURCE</constant>.
(can only be used in <function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>IP_MULTICAST_IF</constant></entry>
<entry>
The outgoing interface for IPv4 multicast packets.
(added in PHP 5.4)
</entry>
<entry>
Either <type>int</type> specifying the interface number or a
<type>string</type> with an interface name, like
<literal>eth0</literal>. The value <type>0</type> can be used to
indicate the routing table is to used in the interface selection.
The function <function>socket_get_option</function> returns an
interface index.
Note that, unlike the C API, this option does NOT take an IP
address. This eliminates the interface difference between
<constant>IP_MULTICAST_IF</constant> and
<constant>IPV6_MULTICAST_IF</constant>.
</entry>
</row>
<row>
<entry><constant>IPV6_MULTICAST_IF</constant></entry>
<entry>
The outgoing interface for IPv6 multicast packets.
(added in PHP 5.4)
</entry>
<entry>
The same as <constant>IP_MULTICAST_IF</constant>.
</entry>
</row>
<row>
<entry><constant>IP_MULTICAST_LOOP</constant></entry>
<entry>
The multicast loopback policy for IPv4 packets, which
determines whether multicast packets sent by this socket also reach
receivers in the same host that have joined the same multicast group
on the outgoing interface used by this socket. This is the case by
default.
(added in PHP 5.4)
</entry>
<entry>
<type>int</type> (either <literal>0</literal> or
<literal>1</literal>). For <function>socket_set_option</function>
any value will be accepted and will be converted to a boolean
following the usual PHP rules.
</entry>
</row>
<row>
<entry><constant>IPV6_MULTICAST_LOOP</constant></entry>
<entry>
Analogous to <constant>IP_MULTICAST_LOOP</constant>, but for IPv6.
(added in PHP 5.4)
</entry>
<entry>
<type>int</type>. See <constant>IP_MULTICAST_LOOP</constant>.
</entry>
</row>
<row>
<entry><constant>IP_MULTICAST_TTL</constant></entry>
<entry>
The time-to-live of outgoing IPv4 multicast packets. This should be
a value between 0 (don't leave the interface) and 255. The default
value is 1 (only the local network is reached).
(added in PHP 5.4)
</entry>
<entry>
<type>int</type> between 0 and 255.
</entry>
</row>
<row>
<entry><constant>IPV6_MULTICAST_HOPS</constant></entry>
<entry>
Analogous to <constant>IP_MULTICAST_TTL</constant>, but for IPv6
packets. The value -1 is also accepted, meaning the route default
should be used.
(added in PHP 5.4)
</entry>
<entry>
<type>int</type> between -1 and 255.
</entry>
</row>
</tbody>
</tgroup>
</table>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the value of the given option, or &false; on errors.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>socket_set_option</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$socket = socket_create_listen(1223);
$linger = array('l_linger' => 1, 'l_onoff' => 1);
socket_set_option($socket, SOL_SOCKET, SO_LINGER, $linger);
var_dump(socket_get_option($socket, SOL_SOCKET, SO_REUSEADDR));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>4.3.0</entry>
<entry>
The name of this function was changed. It used to be called
<literal>socket_getopt()</literal>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
