flush.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 77ae3334a01188bfe7067cf01f1ef6cc19469da3 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.flush">
 <refnamediv>
  <refname>flush</refname>
  <refpurpose>システム出力バッファをフラッシュする</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>flush</methodname>
   <void/>
  </methodsynopsis>
  <para>
   PHP および PHP が使っている (CGI, Web サーバーなどの)
   バックエンドのシステム書き込みバッファをフラッシュします。
   コマンドライン環境では、<function>flush</function>
   はバッファの中身だけをフラッシュしようとします。
   一方で web のコンテキストではヘッダとバッファの内容をフラッシュします。
  </para>
  <note>
   <simpara>
   <function>flush</function> はウェブサーバーのバッファリング手法を上書きすることはできません。
   また、クライアント側のブラウザでのバッファリングにはなんの影響も及ぼしません。
   </simpara>
  </note>
  <note>
   <simpara>
    この関数は、
    <function>ob_start</function>
    や <function>output_add_rewrite_var</function>
    によって開始されたユーザーレベルの出力ハンドラには、何ら影響しません。
   </simpara>
  </note>
  <warning>
   <simpara>
    <function>flush</function> は、
    ハンドラがヘッダを送信する前にヘッダを送信することで、
    web のコンテキストでヘッダを設定したり送信したりするハンドラ
    (例:<function>ob_gzhandler</function>) を中断させることができます。
   </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>
       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
-->