php-doc-ru/reference/stream/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 561e36d646b8e48dc53a910234ee9f30cba147d0 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<appendix xml:id="stream.constants" xmlns="http://docbook.org/ns/docbook">
 &reftitle.constants;
 &extension.constants;

 <variablelist>
  <title>
   Доступные значения параметра <parameter>flags</parameter> функции
   <function>stream_socket_client</function>
  </title>

  <varlistentry xml:id="constant.stream-client-async-connect">
   <term>
    <constant>STREAM_CLIENT_ASYNC_CONNECT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Асинхронное открытие соединения с клиентским сокетом. Настройку
     указывают совместно с флагом
     <constant>STREAM_CLIENT_CONNECT</constant>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-client-connect">
   <term>
    <constant>STREAM_CLIENT_CONNECT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Открытие соединения с клиентским сокетом. Клиентские сокеты
     всегда должны включать этот флаг.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-client-persistent">
   <term>
    <constant>STREAM_CLIENT_PERSISTENT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Клиентский сокет будет оставаться
     открытым между загрузками страниц.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist>
  <title>
   Доступные значения параметра <parameter>flags</parameter> функции
   <function>stream_socket_server</function>
  </title>

  <varlistentry xml:id="constant.stream-server-bind">
   <term>
    <constant>STREAM_SERVER_BIND</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Сообщает потоку связаться с заданной целью.
     Серверные сокеты всегда должны включать этот флаг.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-server-listen">
   <term>
    <constant>STREAM_SERVER_LISTEN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Указывает потоку, связанному флагом
     <constant>STREAM_SERVER_BIND</constant>, начать слушать сокет.
     Передачи данных, устанавливающие соединение (как TCP), должны
     использовать этот флаг, иначе сокет не включится. Использование этого
     флага при передаче без установления соединения (как UDP) вызовет
     ошибку.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist>
  <title>
   Доступные значения параметра <parameter>mode</parameter> функции
   <function>stream_socket_shutdown</function>
  </title>

  <varlistentry xml:id="constant.stream-shut-rd">
   <term>
    <constant>STREAM_SHUT_RD</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Отключить дальнейший приём данных.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-shut-wr">
   <term>
    <constant>STREAM_SHUT_WR</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Отключить дальнейшую передачу данных.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-shut-rdwr">
   <term>
    <constant>STREAM_SHUT_RDWR</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Отключить дальнейший приём и передачу данных.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist>
  <title>Флаги передачи данных Stream Socket</title>
  <simpara>
   Доступные значения параметра <parameter>flags</parameter> функций
   <function>stream_socket_recvfrom</function> и
   <function>stream_socket_sendto</function>
  </simpara>

  <varlistentry xml:id="constant.stream-oob">
   <term>
    <constant>STREAM_OOB</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Обрабатывать <literal>внеполосные</literal> OOB-данные.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-peek">
   <term>
    <constant>STREAM_PEEK</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Получить данные из сокета, но не использовать буфер.
    </simpara>
    <simpara>
     Последующие вызовы функций <function>fread</function>
     или <function>stream_socket_recvfrom</function> будут видеть те же данные.
    </simpara>
    <note>
     <simpara>
      Флаг недопустим для функции <function>stream_socket_sendto</function>.
     </simpara>
    </note>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist>
  <title>Константы Stream Filter</title>
  <simpara>
   Доступные значения для функций
   <function>stream_filter_append</function>
   и <function>stream_filter_prepend</function>.
  </simpara>

  <varlistentry xml:id="constant.stream-filter-read">
   <term>
    <constant>STREAM_FILTER_READ</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Указывает на то, что заданный фильтр может использоваться только в операциях чтения
     (<emphasis>reading</emphasis>).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-filter-write">
   <term>
    <constant>STREAM_FILTER_WRITE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Указывает на то, что заданный фильтр может использоваться только в операциях записи
     (<emphasis>writing</emphasis>).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-filter-all">
   <term>
    <constant>STREAM_FILTER_ALL</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Эквивалентно записи
     <code>STREAM_FILTER_READ | STREAM_FILTER_WRITE</code>.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist>
  <title>
   Методы Stream Crypto
  </title>

  <varlistentry xml:id="constant.stream-crypto-method-any-client">
   <term>
    <constant>STREAM_CRYPTO_METHOD_ANY_CLIENT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Любая TLS- или SSL-версия в клиентском потоке.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-sslv2-client">
   <term>
    <constant>STREAM_CRYPTO_METHOD_SSLv2_CLIENT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     SSL 2.0 в клиентском потоке.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-sslv3-client">
   <term>
    <constant>STREAM_CRYPTO_METHOD_SSLv3_CLIENT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     SSL 3 в клиентском потоке.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-sslv23-client">
   <term>
    <constant>STREAM_CRYPTO_METHOD_SSLv23_CLIENT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     TLS 1.0, 1.1 или 1.2 в клиентском потоке.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-tls-client">
   <term>
    <constant>STREAM_CRYPTO_METHOD_TLS_CLIENT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Любая TLS-версия в клиентском потоке.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-tlsv1-0-client">
   <term>
    <constant>STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     TLS 1.0 в клиентском потоке.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-tlsv1-1-client">
   <term>
    <constant>STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     TLS 1.1 в клиентском потоке.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-tlsv1-2-client">
   <term>
    <constant>STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     TLS 1.2 в клиентском потоке.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-tlsv1-3-client">
   <term>
    <constant>STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     TLS 1.3 в клиентском потоке.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-any-server">
   <term>
    <constant>STREAM_CRYPTO_METHOD_ANY_SERVER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Любая TLS- или SSL-версия в потоке сервера.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-sslv2-server">
   <term>
    <constant>STREAM_CRYPTO_METHOD_SSLv2_SERVER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     SSL 2 в потоке сервера.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-sslv3-server">
   <term>
    <constant>STREAM_CRYPTO_METHOD_SSLv3_SERVER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     SSL 3 в потоке сервера.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-sslv23-server">
   <term>
    <constant>STREAM_CRYPTO_METHOD_SSLv23_SERVER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     TLS 1.0, 1.1 или 1.2 в потоке сервера.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-tls-server">
   <term>
    <constant>STREAM_CRYPTO_METHOD_TLS_SERVER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Любая TLS-версия в потоке сервера.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-tlsv1-0-server">
   <term>
    <constant>STREAM_CRYPTO_METHOD_TLSv1_0_SERVER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     TLS 1.0 в потоке сервера.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-tlsv1-1-server">
   <term>
    <constant>STREAM_CRYPTO_METHOD_TLSv1_1_SERVER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     TLS 1.1 в потоке сервера.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-tlsv1-2-server">
   <term>
    <constant>STREAM_CRYPTO_METHOD_TLSv1_2_SERVER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     TLS 1.2 в потоке сервера.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-method-tlsv1-3-server">
   <term>
    <constant>STREAM_CRYPTO_METHOD_TLSv1_3_SERVER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     TLS 1.3 в потоке сервера.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-proto-sslv3">
   <term>
    <constant>STREAM_CRYPTO_PROTO_SSLv3</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     &Alias; <constant>STREAM_CRYPTO_METHOD_SSLv3_SERVER</constant>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-proto-tlsv1-0">
   <term>
    <constant>STREAM_CRYPTO_PROTO_TLSv1_0</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     &Alias; <constant>STREAM_CRYPTO_METHOD_TLSv1_0_SERVER</constant>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-proto-tlsv1-1">
   <term>
    <constant>STREAM_CRYPTO_PROTO_TLSv1_1</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     &Alias; <constant>STREAM_CRYPTO_METHOD_TLSv1_1_SERVER</constant>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-proto-tlsv1-2">
   <term>
    <constant>STREAM_CRYPTO_PROTO_TLSv1_2</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     &Alias; <constant>STREAM_CRYPTO_METHOD_TLSv1_2_SERVER</constant>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-crypto-proto-tlsv1-3">
   <term>
    <constant>STREAM_CRYPTO_PROTO_TLSv1_3</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     &Alias; <constant>STREAM_CRYPTO_METHOD_TLSv1_3_SERVER</constant>.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist>
  <title>
   Неиспользуемые внутренние константы
  </title>

  <varlistentry xml:id="constant.stream-must-seek">
   <term>
    <constant>STREAM_MUST_SEEK</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Проверяет, что поток доступен для поиска.
     Иногда это приводит к созданию копии потока.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stream-ignore-url">
   <term>
    <constant>STREAM_IGNORE_URL</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Не использовать обёртки плагинов.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <simplesect>
  <title>
   Константы для функции <function>stream_socket_pair</function>
  </title>
  <note>
   <simpara>
    В конкретной системе отдельные константы иногда недоступны.
   </simpara>
  </note>
  <variablelist>
   <title>
    Доступные значения параметра <parameter>domain</parameter>
   </title>
   <varlistentry xml:id="constant.stream-pf-inet">
    <term>
     <constant>STREAM_PF_INET</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      IPv4 — интернет-протокол 4-й версии.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-pf-inet6">
    <term>
     <constant>STREAM_PF_INET6</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      IPv6 — интернет-протокол 6-й версии.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-pf-unix">
    <term>
     <constant>STREAM_PF_UNIX</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Внутренние протоколы системы Unix.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>

  <variablelist>
   <title>
    Доступные значения параметра <parameter>type</parameter>
   </title>
   <varlistentry xml:id="constant.stream-sock-dgram">
    <term>
     <constant>STREAM_SOCK_DGRAM</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Предоставляет датаграммы — сообщения без установления соединения,
      например по протоколу UDP.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-sock-raw">
    <term>
     <constant>STREAM_SOCK_RAW</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Предоставляет необработанный (raw) сокет, который даёт доступ к внутренним
      сетевым протоколам и интерфейсам. Обычно сокеты этого типа
      доступны только root-пользователям.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-sock-rdm">
    <term>
     <constant>STREAM_SOCK_RDM</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Предоставляет сокет RDM (Reliably-delivered messages).
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-sock-seqpacket">
    <term>
     <constant>STREAM_SOCK_SEQPACKET</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Предоставляет сокет последовательного потока пакетов.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-sock-stream">
    <term>
     <constant>STREAM_SOCK_STREAM</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Предоставляет последовательные двунаправленные байтовые потоки
      с механизмом передачи связанных данных, например по протоколу TCP.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>

  <variablelist>
   <title>
    Доступные значения параметра <parameter>protocol</parameter>
   </title>
   <varlistentry xml:id="constant.stream-ipproto-icmp">
    <term>
     <constant>STREAM_IPPROTO_ICMP</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Предоставляет ICMP-сокет.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-ipproto-ip">
    <term>
     <constant>STREAM_IPPROTO_IP</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Предоставляет IP-сокет.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-ipproto-raw">
    <term>
     <constant>STREAM_IPPROTO_RAW</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Предоставляет RAW-сокет.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-ipproto-tcp">
    <term>
     <constant>STREAM_IPPROTO_TCP</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Предоставляет TCP-сокет.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-ipproto-udp">
    <term>
     <constant>STREAM_IPPROTO_UDP</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Предоставляет UDP-сокет.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </simplesect>

 <simplesect>
  <title>
   Константы функции <function>stream_notification_callback</function>
  </title>
  <variablelist>
   <title>
    Доступные значения параметра <parameter>notification_code</parameter>.
   </title>

   <varlistentry xml:id="constant.stream-notify-resolve">
    <term>
     <constant>STREAM_NOTIFY_RESOLVE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Требуемый для потока адрес удалённого ресурса определён, либо это определение
      завершилось неудачей.
     </simpara>
     <simpara>
      Чтобы узнать, что именно произошло, смотрите
      <parameter>severity</parameter>.
     </simpara>
     <warning>
      <simpara>
       Поддержка этого кода уведомления пока не реализована.
      </simpara>
     </warning>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-notify-connect">
    <term>
     <constant>STREAM_NOTIFY_CONNECT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Соединение с внешним ресурсом установлено.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-notify-auth-required">
    <term>
     <constant>STREAM_NOTIFY_AUTH_REQUIRED</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Для доступа к заданному ресурсу необходима дополнительная авторизация.
     </simpara>
     <simpara>
      Обычно выдаётся в ошибке уровня <parameter>severity</parameter>
      <constant>STREAM_NOTIFY_SEVERITY_ERR</constant>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-notify-mime-type-is">
    <term>
     <constant>STREAM_NOTIFY_MIME_TYPE_IS</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <literal>mime-type</literal> ресурса идентифицирован.
     </simpara>
     <simpara>
      Описание найденного типа можно посмотреть в параметре
      <parameter>message</parameter>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-notify-file-size-is">
    <term>
     <constant>STREAM_NOTIFY_FILE_SIZE_IS</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Размер (<literal>size</literal>) ресурса определён.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-notify-redirected">
    <term>
     <constant>STREAM_NOTIFY_REDIRECTED</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Внешний ресурс перенаправил поток в другое место.
     </simpara>
     <simpara>
      Дополнительно смотри <parameter>message</parameter>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-notify-progress">
    <term>
     <constant>STREAM_NOTIFY_PROGRESS</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Индикатор текущего процесса передачи данных через поток.
      Можно узнать, сколько передано (<parameter>bytes_transferred</parameter>),
      и сколько всего байтов (<parameter>bytes_max</parameter>).
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-notify-completed">
    <term>
     <constant>STREAM_NOTIFY_COMPLETED</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      В потоке больше нет доступных данных.
      (Впервые реализовано в PHP 8.3.0).
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-notify-failure">
    <term>
     <constant>STREAM_NOTIFY_FAILURE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Общая ошибка при работе с потоком.
     </simpara>
     <simpara>
      Подробнее рассказывают описания параметров <parameter>message</parameter>
      и <parameter>message_code</parameter>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-notify-auth-result">
    <term>
     <constant>STREAM_NOTIFY_AUTH_RESULT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Авторизация завершена (независимо от успеха авторизации).
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>

  <variablelist>
   <title>
    Доступные значения параметра <parameter>severity</parameter>.
   </title>

   <varlistentry xml:id="constant.stream-notify-severity-info">
    <term>
     <constant>STREAM_NOTIFY_SEVERITY_INFO</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Обычное уведомление, не относящееся к ошибкам.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-notify-severity-warn">
    <term>
     <constant>STREAM_NOTIFY_SEVERITY_WARN</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Некритичная ошибка. Возможно продолжить работу.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-notify-severity-err">
    <term>
     <constant>STREAM_NOTIFY_SEVERITY_ERR</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Критичная ошибка. Продолжение работы невозможно.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </simplesect>

 <simplesect>
  <title>Константы класса <classname>streamWrapper</classname></title>

  <variablelist>
   <title>
    Доступные флаги функции <function>stream_wrapper_register</function>
   </title>

   <varlistentry xml:id="constant.stream-is-url">
    <term>
     <constant>STREAM_IS_URL</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Указывает, что поток — URL-адрес.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>

  <variablelist>
   <title>
    Доступные значения параметра <parameter>cast_as</parameter> метода
    <methodname>streamWrapper::stream_cast</methodname>
   </title>

   <varlistentry xml:id="constant.stream-cast-for-select">
    <term>
     <constant>STREAM_CAST_FOR_SELECT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Указывает, что метод <methodname>streamWrapper::stream_cast</methodname>
      вызвали методом <methodname>streamWrapper::stream_select</methodname>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-cast-as-stream">
    <term>
     <constant>STREAM_CAST_AS_STREAM</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Указывает, что метод <methodname>streamWrapper::stream_cast</methodname>
      вызвали любым методом, кроме метода <methodname>streamWrapper::stream_select</methodname>.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>

  <variablelist>
   <title>

    Доступные значения параметра <parameter>option</parameter> метода
    <methodname>streamWrapper::stream_metadata</methodname>
   </title>

   <varlistentry xml:id="constant.stream-meta-touch">
    <term>
     <constant>STREAM_META_TOUCH</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Указывает на вызов функции <function>touch</function>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-meta-owner">
    <term>
     <constant>STREAM_META_OWNER</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Указывает на вызов функции <function>chown</function>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-meta-owner-name">
    <term>
     <constant>STREAM_META_OWNER_NAME</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Указывает на вызов функции <function>chown</function>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-meta-group">
    <term>
     <constant>STREAM_META_GROUP</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Указывает на вызов функции <function>chgrp</function>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-meta-group-name">
    <term>
     <constant>STREAM_META_GROUP_NAME</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Указывает на вызов функции <function>chgrp</function>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-meta-access">
    <term>
     <constant>STREAM_META_ACCESS</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Указывает на вызов функции <function>chmod</function>.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>

  <variablelist>
   <title>
    Доступные флаги методов
    <methodname>streamWrapper::mkdir</methodname>
    и <methodname>streamWrapper::rmdir</methodname>
   </title>

   <varlistentry xml:id="constant.stream-mkdir-recursive">
    <term>
     <constant>STREAM_MKDIR_RECURSIVE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Рекурсивный флаг для параметров опций функций
      <function>mkdir</function> и <function>rmdir</function>.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>

  <variablelist>
   <title>
    Доступные значения параметра <parameter>options</parameter> метода
    <methodname>streamWrapper::stream_open</methodname>
   </title>

   <varlistentry xml:id="constant.stream-use-path">
    <term>
     <constant>STREAM_USE_PATH</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Флаг, который указывает, что относительным путям потребуется
      включаемый путь, чтобы найти ресурс.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-report-errors">
    <term>
     <constant>STREAM_REPORT_ERRORS</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Флаг, который указывает, что обёртка потока должна сообщать об ошибках.
      Если флаг не установлен, то об ошибках сообщать не следует.
     </simpara>
     <simpara>
      Об ошибках обычно сообщается с помощью функции
      <function>trigger_error</function>.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>

  <variablelist>
   <title>
    Доступные значения параметра <parameter>option</parameter> метода
    <methodname>streamWrapper::stream_set_option</methodname>
   </title>

   <varlistentry xml:id="constant.stream-option-blocking">
    <term>
     <constant>STREAM_OPTION_BLOCKING</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Установка режима блокировки или неблокировки потока.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-option-read-buffer">
    <term>
     <constant>STREAM_OPTION_READ_BUFFER</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Установка буферизации чтения файла в потоке.
     </simpara>
     <variablelist>
      <title>
       Доступные значения
      </title>
      <varlistentry xml:id="constant.stream-buffer-none">
       <term>
        <constant>STREAM_BUFFER_NONE</constant>
        (<type>int</type>)
       </term>
       <listitem>
        <simpara>
         Без буферизации.
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry xml:id="constant.stream-buffer-line">
       <term>
        <constant>STREAM_BUFFER_LINE</constant>
        (<type>int</type>)
       </term>
       <listitem>
        <simpara>
         Буферизация строки.
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry xml:id="constant.stream-buffer-full">
       <term>
        <constant>STREAM_BUFFER_FULL</constant>
        (<type>int</type>)
       </term>
       <listitem>
        <simpara>
         Полная буферизация.
        </simpara>
       </listitem>
      </varlistentry>
     </variablelist>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-option-read-timeout">
    <term>
     <constant>STREAM_OPTION_READ_TIMEOUT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Установка буферизации чтения файла в потоке.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-option-write-buffer">
    <term>
     <constant>STREAM_OPTION_WRITE_BUFFER</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Установка буферизации файла записи в потоке.
     </simpara>
     <simpara>
      Смотрите константу <constant>STREAM_OPTION_READ_BUFFER</constant>
      для получения информации о допустимых параметрах буфера.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>

  <variablelist>
   <title>
    Доступные значения параметра <parameter>flags</parameter> метода
    <methodname>streamWrapper::url_stat</methodname>
   </title>

   <varlistentry xml:id="constant.stream-url-stat-link">
    <term>
     <constant>STREAM_URL_STAT_LINK</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Должна быть возвращена только информация о самой ссылке,
      а не о ресурсе, на который указывает ссылка.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.stream-url-stat-quiet">
    <term>
     <constant>STREAM_URL_STAT_QUIET</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Обёртка не должна вызывать ошибок.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </simplesect>

 <simplesect>
  <title>Константы класса <classname>php_user_filter</classname></title>

  <variablelist>
   <title>
    Доступные возвращаемые значения метода
    <methodname>php_user_filter::filter</methodname>
   </title>

   <varlistentry xml:id="constant.psfs-pass-on">
    <term>
     <constant>PSFS_PASS_ON</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Возвращаемое значение, которое указывает на то, что пользовательский
      фильтр вернул бакеты в <parameter>$out</parameter>.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.psfs-feed-me">
    <term>
     <constant>PSFS_FEED_ME</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Возвращаемое значение, которое указывает на то, что пользовательский
      фильтр не вернул бакеты в <parameter>$out</parameter>.
      (т. е. нет доступных данных).
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.psfs-err-fatal">
    <term>
     <constant>PSFS_ERR_FATAL</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Возвращаемое значение, которое указывает на то, что пользовательский
      фильтр вызвал необрабатываемую ошибку (т. е. получены неверные
      данные).
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>

  <variablelist>
   <title>
    Неиспользуемые внутренние константы
   </title>

   <varlistentry xml:id="constant.psfs-flag-normal">
    <term>
     <constant>PSFS_FLAG_NORMAL</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Нормальные чтение и запись.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.psfs-flag-flush-inc">
    <term>
     <constant>PSFS_FLAG_FLUSH_INC</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Добавочное архивирование.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.psfs-flag-flush-close">
    <term>
     <constant>PSFS_FLAG_FLUSH_CLOSE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Сохранение на диск перед закрытием.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </simplesect>
</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
-->