mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
e41806c30b
Document false and null return types Cf. <https://news-web.php.net/php.doc.cvs/17645>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351730 c90b9560-bf6c-de11-be94-00142212c4b1
134 lines
3.1 KiB
XML
134 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.curl-multi-init" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>curl_multi_init</refname>
|
|
<refpurpose>Returns a new cURL multi handle</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>CurlMultiHandle</type><methodname>curl_multi_init</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
<para>
|
|
Allows the processing of multiple cURL handles asynchronously.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a cURL multi handle on success, &false; on failure.
|
|
</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.0.0</entry>
|
|
<entry>
|
|
On success, this function returns a <classname>CurlMultiHandle</classname> instance now;
|
|
previously, a <type>resource</type> was returned.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>curl_multi_init</function> example</title>
|
|
<para>
|
|
This example will create two cURL handles, add them to a multi
|
|
handle, and process them asynchronously.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// create both cURL resources
|
|
$ch1 = curl_init();
|
|
$ch2 = curl_init();
|
|
|
|
// set URL and other appropriate options
|
|
curl_setopt($ch1, CURLOPT_URL, "http://lxr.php.net/");
|
|
curl_setopt($ch1, CURLOPT_HEADER, 0);
|
|
curl_setopt($ch2, CURLOPT_URL, "http://www.php.net/");
|
|
curl_setopt($ch2, CURLOPT_HEADER, 0);
|
|
|
|
//create the multiple cURL handle
|
|
$mh = curl_multi_init();
|
|
|
|
//add the two handles
|
|
curl_multi_add_handle($mh,$ch1);
|
|
curl_multi_add_handle($mh,$ch2);
|
|
|
|
//execute the multi handle
|
|
do {
|
|
$status = curl_multi_exec($mh, $active);
|
|
if ($active) {
|
|
curl_multi_select($mh);
|
|
}
|
|
} while ($active && $status == CURLM_OK);
|
|
|
|
//close the handles
|
|
curl_multi_remove_handle($mh, $ch1);
|
|
curl_multi_remove_handle($mh, $ch2);
|
|
curl_multi_close($mh);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>curl_init</function></member>
|
|
<member><function>curl_multi_close</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
|
|
-->
|