curl-multi-select.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.curl-multi-select" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>curl_multi_select</refname>
  <refpurpose>Wait until reading or writing is possible for any cURL multi handle connection</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>
   Blocks the execution of the script until a cURL handle attached to
   the cURL multi handle would be able to make progress on the next call to
   <function>curl_multi_exec</function> or until the timeout strikes
   (whichever comes first).
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &curl.mh.description;
    <varlistentry>
     <term><parameter>timeout</parameter></term>
     <listitem>
      <para>
       Time, in seconds, to wait for a response from the active cURL multi handle connections.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   On success, returns the number of active descriptors contained in
   the descriptor sets. This may be <literal>0</literal> if there was no activity on any
   of the descriptors. On failure, this function will
   return <literal>-1</literal> on a select failure (from the
   underlying <literal>select()</literal> system call).
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   Throws a <exceptionname>ValueError</exceptionname> if <parameter>timeout</parameter>
   is less than <literal>0</literal> or greater than <constant>PHP_INT_MAX</constant>.
  </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>
       Now throws a <exceptionname>ValueError</exceptionname> if <parameter>timeout</parameter>
       is less than <literal>0</literal> or greater than <constant>PHP_INT_MAX</constant>.
      </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
-->