flush.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.flush">
 <refnamediv>
  <refname>flush</refname>
  <refpurpose>Flush system output buffer</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>flush</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Flushes the system write buffers of PHP and the backend used by PHP
   (e.g.: CGI, a web server).
   In a command line environment <function>flush</function>
   will attempt to flush the contents of the buffers only
   whereas in a web context headers and the contents of the buffers are flushed.
  </para>
  <note>
   <simpara>
    <function>flush</function> may not be able to override
    the buffering scheme of the web server
    and it has no effect on any client-side buffering in the browser.
   </simpara>
  </note>
  <note>
   <simpara>
    This function does not have any effect on user level output handlers
    such as those started by <function>ob_start</function>
    or <function>output_add_rewrite_var</function>.
   </simpara>
  </note>
  <warning>
   <simpara>
    <function>flush</function> can interfere with output handlers
    that set and send headers in a web context (e.g. <function>ob_gzhandler</function>)
    by sending headers before these handlers can do so.
   </simpara>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.4.0</entry>
      <entry>
       Flushing headers without a body will now succeed in FastCGI.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ob_flush</function></member>
    <member><function>ob_clean</function></member>
    <member><function>ob_end_flush</function></member>
    <member><function>ob_end_clean</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
-->