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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<appendix xml:id="stream.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&extension.constants;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>STREAM_FILTER_READ</constant> *</entry>
<entry>
Used with <function>stream_filter_append</function> and
<function>stream_filter_prepend</function> to indicate
that the specified filter should only be applied when
<emphasis>reading</emphasis>
</entry>
</row>
<row>
<entry><constant>STREAM_FILTER_WRITE</constant> *</entry>
<entry>
Used with <function>stream_filter_append</function> and
<function>stream_filter_prepend</function> to indicate
that the specified filter should only be applied when
<emphasis>writing</emphasis>
</entry>
</row>
<row>
<entry><constant>STREAM_FILTER_ALL</constant> *</entry>
<entry>
This constant is equivalent to
<code>STREAM_FILTER_READ | STREAM_FILTER_WRITE</code>
</entry>
</row>
<row>
<entry><constant>PSFS_PASS_ON</constant> *</entry>
<entry><literal>Return Code</literal> indicating that the
userspace filter returned buckets in <parameter>$out</parameter>.
</entry>
</row>
<row>
<entry><constant>PSFS_FEED_ME</constant> *</entry>
<entry><literal>Return Code</literal> indicating that the
userspace filter did not return buckets in <parameter>$out</parameter>
(i.e. No data available).
</entry>
</row>
<row>
<entry><constant>PSFS_ERR_FATAL</constant> *</entry>
<entry><literal>Return Code</literal> indicating that the
userspace filter encountered an unrecoverable error
(i.e. Invalid data received).
</entry>
</row>
<row>
<entry><constant>PSFS_FLAG_NORMAL</constant></entry>
<entry>Regular read/write.</entry>
</row>
<row>
<entry><constant>PSFS_FLAG_FLUSH_INC</constant></entry>
<entry>An incremental flush.</entry>
</row>
<row>
<entry><constant>PSFS_FLAG_FLUSH_CLOSE</constant></entry>
<entry>Final flush prior to closing.</entry>
</row>
<row>
<entry><constant>STREAM_USE_PATH</constant></entry>
<entry><literal>Flag</literal> indicating if the <literal>stream</literal>
used the include path.
</entry>
</row>
<row>
<entry><constant>STREAM_REPORT_ERRORS</constant></entry>
<entry><literal>Flag</literal> indicating if the <literal>wrapper</literal>
is responsible for raising errors using <function>trigger_error</function>
during opening of the stream. If this flag is not set, you
should not raise any errors.
</entry>
</row>
<row>
<entry><constant>STREAM_CLIENT_ASYNC_CONNECT</constant> *</entry>
<entry>Open client socket asynchronously. This option must be used
together with the <constant>STREAM_CLIENT_CONNECT</constant> flag.
Used with <function>stream_socket_client</function>.
</entry>
</row>
<row>
<entry><constant>STREAM_CLIENT_CONNECT</constant> *</entry>
<entry>Open client socket connection. Client sockets should always
include this flag. Used with <function>stream_socket_client</function>.
</entry>
</row>
<row>
<entry><constant>STREAM_CLIENT_PERSISTENT</constant> *</entry>
<entry>Client socket opened with <function>stream_socket_client</function>
should remain persistent between page loads.
</entry>
</row>
<row>
<entry><constant>STREAM_SERVER_BIND</constant> *</entry>
<entry>Tells a stream created with <function>stream_socket_server</function>
to bind to the specified target. Server sockets should always include this flag.
</entry>
</row>
<row>
<entry><constant>STREAM_SERVER_LISTEN</constant> *</entry>
<entry>Tells a stream created with <function>stream_socket_server</function>
and bound using the <constant>STREAM_SERVER_BIND</constant> flag to start
listening on the socket. Connection-orientated transports (such as TCP)
must use this flag, otherwise the server socket will not be enabled.
Using this flag for connect-less transports (such as UDP) is an error.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_RESOLVE</constant> *</entry>
<entry>
A remote address required for this stream has been resolved, or the resolution
failed. See <parameter>severity</parameter> for an indication of which happened.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_CONNECT</constant></entry>
<entry>
A connection with an external resource has been established.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_AUTH_REQUIRED</constant></entry>
<entry>
Additional authorization is required to access the specified resource.
Typical issued with <parameter>severity</parameter> level of
<constant>STREAM_NOTIFY_SEVERITY_ERR</constant>.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_MIME_TYPE_IS</constant></entry>
<entry>
The <literal>mime-type</literal> of resource has been identified,
refer to <parameter>message</parameter> for a description of the
discovered type.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_FILE_SIZE_IS</constant></entry>
<entry>
The <literal>size</literal> of the resource has been discovered.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_REDIRECTED</constant></entry>
<entry>
The external resource has redirected the stream to an alternate
location. Refer to <parameter>message</parameter>.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_PROGRESS</constant></entry>
<entry>
Indicates current progress of the stream transfer in
<parameter>bytes_transferred</parameter> and possibly
<parameter>bytes_max</parameter> as well.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_COMPLETED</constant> *</entry>
<entry>
There is no more data available on the stream.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_FAILURE</constant></entry>
<entry>
A generic error occurred on the stream, consult
<parameter>message</parameter> and <parameter>message_code</parameter>
for details.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_AUTH_RESULT</constant></entry>
<entry>
Authorization has been completed (with or without success).
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_SEVERITY_INFO</constant></entry>
<entry>
Normal, non-error related, notification.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_SEVERITY_WARN</constant></entry>
<entry>
Non critical error condition. Processing may continue.
</entry>
</row>
<row>
<entry><constant>STREAM_NOTIFY_SEVERITY_ERR</constant></entry>
<entry>
A critical error occurred. Processing cannot continue.
</entry>
</row>
<row>
<entry><constant>STREAM_IPPROTO_ICMP</constant> +</entry>
<entry>
Provides a ICMP socket.
</entry>
</row>
<row>
<entry><constant>STREAM_IPPROTO_IP</constant> +</entry>
<entry>
Provides a IP socket.
</entry>
</row>
<row>
<entry><constant>STREAM_IPPROTO_RAW</constant> +</entry>
<entry>
Provides a RAW socket.
</entry>
</row>
<row>
<entry><constant>STREAM_IPPROTO_TCP</constant> +</entry>
<entry>
Provides a TCP socket.
</entry>
</row>
<row>
<entry><constant>STREAM_IPPROTO_UDP</constant> +</entry>
<entry>
Provides a UDP socket.
</entry>
</row>
<row>
<entry><constant>STREAM_PF_INET</constant> +</entry>
<entry>
Internet Protocol Version 4 (IPv4).
</entry>
</row>
<row>
<entry><constant>STREAM_PF_INET6</constant> +</entry>
<entry>
Internet Protocol Version 6 (IPv6).
</entry>
</row>
<row>
<entry><constant>STREAM_PF_UNIX</constant> +</entry>
<entry>
Unix system internal protocols.
</entry>
</row>
<row>
<entry><constant>STREAM_SOCK_DGRAM</constant> +</entry>
<entry>
Provides datagrams, which are connectionless messages (UDP, for
example).
</entry>
</row>
<row>
<entry><constant>STREAM_SOCK_RAW</constant> +</entry>
<entry>
Provides a raw socket, which provides access to internal network
protocols and interfaces. Usually this type of socket is just available
to the root user.
</entry>
</row>
<row>
<entry><constant>STREAM_SOCK_RDM</constant> +</entry>
<entry>
Provides a RDM (Reliably-delivered messages) socket.
</entry>
</row>
<row>
<entry><constant>STREAM_SOCK_SEQPACKET</constant> +</entry>
<entry>
Provides a sequenced packet stream socket.
</entry>
</row>
<row>
<entry><constant>STREAM_SOCK_STREAM</constant> +</entry>
<entry>
Provides sequenced, two-way byte streams with a transmission mechanism
for out-of-band data (TCP, for example).
</entry>
</row>
<row>
<entry><constant>STREAM_SHUT_RD</constant></entry>
<entry>
Used with <function>stream_socket_shutdown</function> to disable
further receptions. Added in PHP 5.2.1.
</entry>
</row>
<row>
<entry><constant>STREAM_SHUT_WR</constant></entry>
<entry>
Used with <function>stream_socket_shutdown</function> to disable
further transmissions. Added in PHP 5.2.1.
</entry>
</row>
<row>
<entry><constant>STREAM_SHUT_RDWR</constant></entry>
<entry>
Used with <function>stream_socket_shutdown</function> to disable
further receptions and transmissions. Added in PHP 5.2.1.
</entry>
</row>
<row>
<entry><constant>STREAM_CAST_FOR_SELECT</constant></entry>
<entry>
Stream casting, for when <function>stream_select</function> is
calling <function>stream_cast</function>.
</entry>
</row>
<row>
<entry><constant>STREAM_CAST_AS_STREAM</constant></entry>
<entry>
Stream casting, when <function>stream_cast</function> is called
otherwise (see above).
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<note>
<simpara>
The constants marked with <literal>*</literal> are just available since
PHP 5.0.0.
</simpara>
</note>
<note>
<simpara>
The constants marked with <literal>+</literal> are available since PHP
5.1.0 and are meant to be used with
<function>stream_socket_pair</function>. Please note that some of these
constants might not be available in your system.
</simpara>
</note>
</appendix>
<!-- 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
-->
|
