trAvis - MANAGER

Edit File: curlmultiobject.html

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
 <title>PycURL: CurlMulti Objects</title>
 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
 <meta name="revisit-after" content="30 days" />
 <meta name="robots" content="noarchive, index, follow" />
</head>
<body>

<h1>CurlMulti Object</h1>

CurlMulti objects have the following methods:

<dl>
<dt><code>close()</code> -&gt; None</dt>
<dd>
Corresponds to
<a href="http://curl.haxx.se/libcurl/c/curl_multi_cleanup.html"><code>curl_multi_cleanup()</code></a> in libcurl.
This method is automatically called by pycurl when a CurlMulti object no
longer has any references to it, but can also be called
explicitly.
</dd>

<dt><code>perform()</code> -&gt; tuple of status and the number of active Curl objects</dt>
<dd>
Corresponds to
<a href="http://curl.haxx.se/libcurl/c/curl_multi_perform.html"><code>curl_multi_perform()</code></a> in libcurl.
</dd>

<dt><code> add_handle(</code>Curl object<code>) </code>-&gt; None</dt>
<dd>
Corresponds to
<a href="http://curl.haxx.se/libcurl/c/curl_multi_add_handle.html"><code>curl_multi_add_handle()</code></a> in libcurl.
This method adds an existing and valid Curl object to the CurlMulti
object.

IMPORTANT NOTE: add_handle does not implicitly add a Python reference
to the Curl object (and thus does not increase the reference count on the Curl
object).
</dd>

<dt><code>remove_handle(</code>Curl object<code>)</code> -&gt; None</dt>
<dd>
Corresponds to
<a href="http://curl.haxx.se/libcurl/c/curl_multi_remove_handle.html"><code>curl_multi_remove_handle()</code></a> in libcurl.
This method removes an existing and valid Curl object from the CurlMulti
object.

IMPORTANT NOTE: remove_handle does not implicitly remove a Python reference
from the Curl object (and thus does not decrease the reference count on the Curl
object).
</dd>

<dt><code>fdset()</code> -&gt;
triple of lists with active file descriptors,
readable, writeable, exceptions.</dt>
<dd>
Corresponds to
<a href="http://curl.haxx.se/libcurl/c/curl_multi_fdset.html"><code>curl_multi_fdset()</code></a> in libcurl.
This method extracts the file descriptor information from a CurlMulti object.
The returned lists can be used with the <code>select</code> module to
poll for events.

Example usage:

<pre>
import pycurl
c = pycurl.Curl()
c.setopt(pycurl.URL, "http://curl.haxx.se")
m = pycurl.CurlMulti()
m.add_handle(c)
while 1:
 ret, num_handles = m.perform()
 if ret != pycurl.E_CALL_MULTI_PERFORM: break
while num_handles:
 apply(select.select, m.fdset() + (1,))
 while 1:
 ret, num_handles = m.perform()
 if ret != pycurl.E_CALL_MULTI_PERFORM: break
</pre>
</dd>

<dt><code>select(</code>timeout<code>)</code> -&gt;
number of ready file descriptors or -1 on timeout</dt>
<dd>
This is a convenience function which simplifies the combined
use of <code>fdset()</code> and the <code>select</code> module.

Example usage:

<pre>import pycurl
c = pycurl.Curl()
c.setopt(pycurl.URL, "http://curl.haxx.se")
m = pycurl.CurlMulti()
m.add_handle(c)
while 1:
 ret, num_handles = m.perform()
 if ret != pycurl.E_CALL_MULTI_PERFORM: break
while num_handles:
 ret = m.select(1.0)
 if ret == -1: continue
 while 1:
 ret, num_handles = m.perform()
 if ret != pycurl.E_CALL_MULTI_PERFORM: break
</pre>
</dd>

<dt><code>info_read(</code>[max]<code>)</code> -&gt;
numberof queued messages, a list of successful objects, a list of
failed objects</dt>
<dd>
Corresponds to the
<a href="http://curl.haxx.se/libcurl/c/curl_multi_info_read.html"><code>curl_multi_info_read()</code></a> function in libcurl.
This method extracts at most max messages
from the multi stack and returns them in two lists. The first
list contains the handles which completed successfully and the second
list contains a tuple &lt;curl object, curl error number, curl
error message&gt; for each failed curl object. The number
of queued messages after this method has been called is also
returned.
</dd>
</dl>

<hr />

 <a href="http://validator.w3.org/check/referer"><img align="right"
 src="http://www.w3.org/Icons/valid-xhtml10"
 alt="Valid XHTML 1.0!" height="31" width="88" border="0" /></a>
 $Id: curlmultiobject.html,v 1.5 2005/03/11 13:32:12 kjetilja Exp $

</body>
</html>