php-doc-en/reference/stream/functions/stream-set-write-buffer.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
  <refentry id="function.stream-set-write-buffer">
   <refnamediv>
    <refname>stream_set_write_buffer</refname>
    <refpurpose>Sets file buffering on the given stream</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>stream_set_write_buffer</methodname>
      <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>buffer</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     Output using <function>fwrite</function> is normally buffered at
     8K.  This means that if there are two processes wanting to write
     to the same output stream (a file), each is paused after 8K of
     data to allow the other to write.
     <function>stream_set_write_buffer</function>
     sets the buffering for write operations on the given filepointer
     <parameter>stream</parameter> to <parameter>buffer</parameter> bytes.
     If <parameter>buffer</parameter> is 0 then write operations are
     unbuffered.  This ensures that all writes with
     <function>fwrite</function> are completed before other processes
     are allowed to write to that output stream.
    </simpara>
    <simpara>
     The function returns 0 on success, or EOF if the request cannot
     be honored.
    </simpara>
    <para>
     The following example demonstrates how to use
     <function>stream_set_write_buffer</function> to create an unbuffered stream.
     <example>
      <title><function>stream_set_write_buffer</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php
$fp = fopen($file, "w");
if ($fp) {
  stream_set_write_buffer($fp, 0);
  fwrite($fp, $output);
  fclose($fp);
}
?>
]]>
      </programlisting>
     </example>
    </para>

    <simpara>
     See also
     <function>fopen</function> and
     <function>fwrite</function>.
    </simpara>
   </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:"../../../../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
-->