curl-multi-select.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f414967c2c80702de6401191034d9837a2801dc1 Maintainer: takagi Status: ready -->
<refentry xml:id="function.curl-multi-select" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>curl_multi_select</refname>
  <refpurpose>任意の cURL マルチハンドル接続で読み取りまたは書き込みが可能になるまで待機する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>curl_multi_select</methodname>
   <methodparam><type>CurlMultiHandle</type><parameter>multi_handle</parameter></methodparam>
   <methodparam choice="opt"><type>float</type><parameter>timeout</parameter><initializer>1.0</initializer></methodparam>
  </methodsynopsis>
  <para>
   スクリプトの実行をブロックし、次の <function>curl_multi_exec</function> の呼び出しで
   cURL マルチハンドルに関連付けられた cURL ハンドルが処理を進められるようになるか、
   タイムアウトになるまで待機します（どちらか早い方が適用されます）。
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &curl.mh.description;
    <varlistentry>
     <term><parameter>timeout</parameter></term>
     <listitem>
      <para>
       アクティブな cURL マルチハンドル接続からのレスポンスを待機する時間（秒単位）。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合は、記述子セットに含まれるアクティブな記述子の数を返します。
   どの記述子上にもアクティビティがなかった場合は、結果が <literal>0</literal> になることもあります。
   (<literal>select()</literal> システムコールから) select に失敗した場合は <literal>-1</literal> を返します。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   <parameter>timeout</parameter> が <literal>0</literal> 未満または <constant>PHP_INT_MAX</constant>
   を超える場合、<exceptionname>ValueError</exceptionname> をスローします。
  </simpara>
 </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>
       <parameter>timeout</parameter> が <literal>0</literal> 未満または <constant>PHP_INT_MAX</constant>
       を超える場合、<exceptionname>ValueError</exceptionname> をスローするようになりました。
      </entry>
     </row>
     &curl.changelog.multi-handle-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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