<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<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>Change stream options</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>
   This method is called to set options on the stream.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       One of:
       <simplelist>
        <member><constant>STREAM_OPTION_BLOCKING</constant> (The method was called in response to <function>stream_set_blocking</function>)</member>
        <member><constant>STREAM_OPTION_READ_TIMEOUT</constant> (The method was called in response to <function>stream_set_timeout</function>)</member>
        <member><constant>STREAM_OPTION_WRITE_BUFFER</constant> (The method was called in response to  <function>stream_set_write_buffer</function>)</member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>arg1</parameter></term>
     <listitem>
      <para>
       If <parameter>option</parameter> is
       <simplelist>
        <member><constant>STREAM_OPTION_BLOCKING</constant>: requested blocking mode (1 meaning block 0 not blocking).</member>
        <member><constant>STREAM_OPTION_READ_TIMEOUT</constant>: the timeout in seconds.</member>
        <member><constant>STREAM_OPTION_WRITE_BUFFER</constant>: buffer mode (<constant>STREAM_BUFFER_NONE</constant> or <constant>STREAM_BUFFER_FULL</constant>).</member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>arg2</parameter></term>
     <listitem>
      <para>
       If <parameter>option</parameter> is
       <simplelist>
        <member><constant>STREAM_OPTION_BLOCKING</constant>: This option is not set.</member>
        <member><constant>STREAM_OPTION_READ_TIMEOUT</constant>: the timeout in microseconds.</member>
        <member><constant>STREAM_OPTION_WRITE_BUFFER</constant>: the requested buffer size.</member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
   If <parameter>option</parameter> is not implemented, &false; should be
   returned.
  </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
-->
