php-doc-en/reference/stream/constants.xml
Moriyoshi Koizumi 58f87d3bee Fixed typo
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@126273 c90b9560-bf6c-de11-be94-00142212c4b1
2003-05-08 17:53:29 +00:00

216 lines
7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<section id="stream.constants">
&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>writting</emphasis>
</entry>
</row>
<row>
<entry><constant>STREAM_FILTER_ALL</constant></entry>
<entry>
This constant is equivalent to
<literal><constant>STREAM_FILTER_READ</constant> |
<constant>STREAM_FILTER_WRITE</constant></literal>
</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>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. 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. Server sockets should always include this flag.
</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 occured 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 realted, 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 occured. Processing cannot continue.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>
<!-- 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
-->