php-doc-en/reference/outcontrol/functions/flush.xml
Rasmus Lerdorf 3739ac5804 Clarify flush() docs and close bug#48933
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@284289 c90b9560-bf6c-de11-be94-00142212c4b1
2009-07-18 00:04:18 +00:00

80 lines
2.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.flush">
<refnamediv>
<refname>flush</refname>
<refpurpose>Flush the output buffer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>flush</methodname>
<void/>
</methodsynopsis>
<para>
Flushes the write buffers of PHP and whatever backend PHP is using (CGI,
a web server, etc). This attempts to push current output all the way to
the browser with a few caveats.
</para>
<para>
<function>flush</function> may not be able to override the buffering scheme
of your web server and it has no effect on any client-side buffering in the
browser. It also doesn't affect PHP's userspace output buffering mechanism.
This means you will have to call both <function>ob_flush</function> and
<function>flush</function> to flush the ob output buffers if you are using
those.
</para>
<para>
Several servers, especially on Win32, will still buffer the output from
your script until it terminates before transmitting the results to the
browser.
</para>
<para>
Server modules for Apache like mod_gzip may do buffering of their own that
will cause <function>flush</function> to not result in data being sent
immediately to the client.
</para>
<para>
Even the browser may buffer its input before displaying it. Netscape, for
example, buffers text until it receives an end-of-line or the beginning of
a tag, and it won't render tables until the &lt;/table&gt; tag of the
outermost table is seen.
</para>
<para>
Some versions of Microsoft Internet Explorer will only start to display
the page after they have received 256 bytes of output, so you may need to
send extra whitespace before flushing to get those browsers to display the
page.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</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:"../../../../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
-->