stream-set-blocking.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a94b259189d1d013968af18f56048dbb52472225 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.stream-set-blocking" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stream_set_blocking</refname>
  <refpurpose>ストリームのブロックモードを有効にする / 解除する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>stream_set_blocking</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam><type>bool</type><parameter>enable</parameter></methodparam>
  </methodsynopsis>
  <para>
   <parameter>stream</parameter> のモードをブロックあるいは非ブロックに設定します。
  </para>
  <para>
   この関数は、非ブロックモードをサポートするすべてのストリーム
   (現在は、通常のファイルストリームとソケットストリームのみ)
   において利用可能です。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      <para>
       ストリーム。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>enable</parameter></term>
     <listitem>
      <para>
       <parameter>enable</parameter> が &false; の時、ストリームは
       非ブロックモードに切り替えられ、&true; の場合は、
       ブロックモードに切り替えられます。このモードの違いは、
       <function>fgets</function> や <function>fread</function>
       といった、ストリームからデータを読む関数に影響します。
       非ブロックモードにおいては <function>fgets</function> を呼び出すと
       どんな場合でもただちに呼び出し元に戻りますが、ブロックモードの場合では、
       ストリームがデータを読み出せる状態になるまで待ちつづけます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Windowsでは、これはローカルファイルには影響しません。
    ローカルファイルのノンブロッキングI/Oは、Windowsではサポートされていません。
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>stream_select</function></member>
  </simplelist>
 </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
-->