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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.15 $ -->
<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
SOL_SOCKET would be used. Other levels, such as TCP, 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>SO_DEBUG</entry>
<entry>
Reports whether debugging information is being recorded.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry>SO_BROADCAST</entry>
<entry>
Reports whether transmission of broadcast messages is supported.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry>SO_REUSEADDR</entry>
<entry>
Reports whether local addresses can be reused.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry>SO_KEEPALIVE</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>SO_LINGER</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>SO_OOBINLINE</entry>
<entry>
Reports whether the <parameter>socket</parameter> leaves out-of-band data inline.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry>SO_SNDBUF</entry>
<entry>
Reports the size of the send buffer.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry>SO_RCVBUF</entry>
<entry>
Reports the size of the receive buffer.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry>SO_ERROR</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>SO_TYPE</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>SO_DONTROUTE</entry>
<entry>
Reports whether outgoing messages bypass the standard routing facilities.
</entry>
<entry>
<type>int</type>
</entry>
</row>
<row>
<entry>SO_RCVLOWAT</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>SO_RCVTIMEO</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>SO_SNDTIMEO</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>SO_SNDLOWAT</entry>
<entry>
Reports the minimum number of bytes to process for <parameter>socket</parameter> output operations.
</entry>
<entry>
<type>int</type>
</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:"../../../../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
-->
|
