archived-doc-ru/reference/stream/streamwrapper/stream-set-option.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: de8e36659fb2b22c9b60ffa0380d9bea945b2819 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="streamwrapper.stream-set-option" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>streamWrapper::stream_set_option</refname>
  <refpurpose>Изменение настроек потока</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_set_option</methodname>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam><type>int</type><parameter>arg1</parameter></methodparam>
   <methodparam><type>int</type><parameter>arg2</parameter></methodparam>
  </methodsynopsis>
  <para>
   Этот метод вызывается при установке настроек потока.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       Одно из значений:
       <simplelist>
        <member>
         <constant>STREAM_OPTION_BLOCKING</constant>
         (Метод вызван в результате вызова функции
         <function>stream_set_blocking</function>)
        </member>
        <member>
         <constant>STREAM_OPTION_READ_TIMEOUT</constant>
         (Метод вызван в результате вызова функции
         <function>stream_set_timeout</function>)
        </member>
        <member>
         <constant>STREAM_OPTION_READ_BUFFER</constant>
         (Метод вызван в результате вызова функции
         <function>stream_set_read_buffer</function>)
        </member>
        <member>
         <constant>STREAM_OPTION_WRITE_BUFFER</constant>
         (Метод вызван в результате вызова функции
         <function>stream_set_write_buffer</function>)
        </member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>arg1</parameter></term>
     <listitem>
      <para>
       Если <parameter>option</parameter> принимает значение:
       <simplelist>
        <member>
         <constant>STREAM_OPTION_BLOCKING</constant>:
         запрошен режим блокировки (1 — блокировать, 0 — не блокировать).
        </member>
        <member>
         <constant>STREAM_OPTION_READ_TIMEOUT</constant>: время ожидания в секундах.
        </member>
        <member>
         <constant>STREAM_OPTION_READ_BUFFER</constant>: режим буфера
         (опции <constant>STREAM_BUFFER_NONE</constant> или <constant>STREAM_BUFFER_FULL</constant>).
        </member>
        <member>
         <constant>STREAM_OPTION_WRITE_BUFFER</constant>:
         режим буферизации (<constant>STREAM_BUFFER_NONE</constant> или
         <constant>STREAM_BUFFER_FULL</constant>).
        </member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>arg2</parameter></term>
     <listitem>
      <para>
       Если <parameter>option</parameter> принимает значение:
       <simplelist>
        <member>
         <constant>STREAM_OPTION_BLOCKING</constant>: это значение ни на что не влияет.
        </member>
        <member>
         <constant>STREAM_OPTION_READ_TIMEOUT</constant>: время ожидания в микросекундах.
        </member>
        <member>
         <constant>STREAM_OPTION_READ_BUFFER</constant>: требуемый размер буфера.
        </member>
        <member>
         <constant>STREAM_OPTION_WRITE_BUFFER</constant>: требуемый размер буфера.
        </member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
   Если <parameter>option</parameter> не реализован, метод должен возвращать &false;.
  </para>
 </refsect1>

<!--
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>streamWrapper::stream_set_option</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
...
]]>
    </screen>
   </example>
  </para>
 </refsect1>
-->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>stream_set_blocking</function></member>
    <member><function>stream_set_timeout</function></member>
    <member><function>stream_set_write_buffer</function></member>
   </simplelist>
  </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
-->