twisted.internet.defer.DeferredList.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.internet.defer.DeferredList</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.internet.html">Package internet</a> ::
<a href="twisted.internet.defer.html">Module defer</a> ::
Class DeferredList
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.internet.defer.DeferredList.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class DeferredList</h2>
<pre class="base-tree">
<a href="twisted.internet.defer.Deferred.html"><code>Deferred</code></a> --+
|
<b>DeferredList</b>
</pre><br />
<hr/>
<p>I combine a group of deferreds into one callback.</p>
<p>I track a list of <a href="twisted.internet.defer.Deferred.html"
class="link"><code>Deferred</code></a>s for their callbacks, and make a
single callback when they have all completed, a list of (success, result)
tuples, 'success' being a boolean.</p>
Note that you can still use a <a
href="twisted.internet.defer.Deferred.html"
class="link"><code>Deferred</code></a> after putting it in a
DeferredList. For example, you can suppress 'Unhandled error in Deferred'
messages by adding errbacks to the Deferreds *after* putting them in the
DeferredList, as a DeferredList won't swallow the errors. (Although a
more convenient way to do this is simply to set the consumeErrors
flag)
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.DeferredList.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>deferredList</span>,
<span class=summary-sig-arg>fireOnOneCallback</span>,
<span class=summary-sig-arg>fireOnOneErrback</span>,
<span class=summary-sig-arg>consumeErrors</span>)</span></code>
<br />
Initialize a DeferredList.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.DeferredList.html#_cbDeferred" class="summary-sig-name"><code>_cbDeferred</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>result</span>,
<span class=summary-sig-arg>index</span>,
<span class=summary-sig-arg>succeeded</span>)</span></code>
<br />
(internal) Callback for when one of my deferreds fires.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.DeferredList.html#addDeferred" class="summary-sig-name"><code>addDeferred</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>deferred</span>)</span></code>
<br />
DEPRECATED</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Deferred</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#__del__" class="summary-sig-name"><code>__del__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Print tracebacks and die.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#__str__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#_continue" class="summary-sig-name"><code>_continue</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>result</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#_debugInfo" class="summary-sig-name"><code>_debugInfo</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#_runCallbacks" class="summary-sig-name"><code>_runCallbacks</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#_startRunCallbacks" class="summary-sig-name"><code>_startRunCallbacks</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>result</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#addBoth" class="summary-sig-name"><code>addBoth</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>callback</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Convenience method for adding a single callable as both a callback and
an errback.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#addCallback" class="summary-sig-name"><code>addCallback</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>callback</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Convenience method for adding just a callback.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#addCallbacks" class="summary-sig-name"><code>addCallbacks</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>callback</span>,
<span class=summary-sig-arg>errback</span>,
<span class=summary-sig-arg>callbackArgs</span>,
<span class=summary-sig-arg>callbackKeywords</span>,
<span class=summary-sig-arg>errbackArgs</span>,
<span class=summary-sig-arg>errbackKeywords</span>,
<span class=summary-sig-arg>asDefaults</span>)</span></code>
<br />
Add a pair of callbacks (success and error) to this Deferred.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#addErrback" class="summary-sig-name"><code>addErrback</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>errback</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Convenience method for adding just an errback.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#arm" class="summary-sig-name"><code>arm</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
This method is deprecated.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#callback" class="summary-sig-name"><code>armAndCallback</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>result</span>)</span></code>
<br />
Run all success callbacks that have been added to this Deferred.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#chainDeferred" class="summary-sig-name"><code>armAndChain</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>d</span>)</span></code>
<br />
Chain another Deferred to this Deferred.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#errback" class="summary-sig-name"><code>armAndErrback</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>fail</span>)</span></code>
<br />
Run all error callbacks that have been added to this Deferred.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#callback" class="summary-sig-name"><code>callback</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>result</span>)</span></code>
<br />
Run all success callbacks that have been added to this Deferred.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#chainDeferred" class="summary-sig-name"><code>chainDeferred</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>d</span>)</span></code>
<br />
Chain another Deferred to this Deferred.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#errback" class="summary-sig-name"><code>errback</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>fail</span>)</span></code>
<br />
Run all error callbacks that have been added to this Deferred.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#pause" class="summary-sig-name"><code>pause</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Stop processing on a Deferred until <a
href="twisted.internet.defer.Deferred.html#unpause"
class="link"><code>unpause</code></a>() is called.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#setTimeout" class="summary-sig-name"><code>setTimeout</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>seconds</span>,
<span class=summary-sig-arg>timeoutFunc</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Set a timeout function to be triggered if I am not called.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.defer.Deferred.html#unpause" class="summary-sig-name"><code>unpause</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Process all callbacks made since <a
href="twisted.internet.defer.Deferred.html#pause"
class="link"><code>pause</code></a>() was called.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.defer.DeferredList.html#fireOnOneCallback"><code>fireOnOneCallback</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.defer.DeferredList.html#fireOnOneErrback"><code>fireOnOneErrback</code></a></b> = <span title="0">0 </span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Deferred</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.defer.Deferred.html#called"><code>called</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.defer.Deferred.html#debug"><code>debug</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.defer.Deferred.html#default"><code>default</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.defer.Deferred.html#paused"><code>paused</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.internet.defer.Deferred.html#timeoutCall"><code>timeoutCall</code></a></b> = <span title="None">None </span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>deferredList</span>,
<span class=sig-arg>fireOnOneCallback</span>=<span class=sig-default>0</span>,
<span class=sig-arg>fireOnOneErrback</span>=<span class=sig-default>0</span>,
<span class=sig-arg>consumeErrors</span>=<span class=sig-default>0</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Initialize a DeferredList.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>deferredList</b></code> -
The list of deferreds to track.
<br /><i>
(type=<code>list</code> of <a
href="twisted.internet.defer.Deferred.html"
class="link"><code>Deferred</code></a>s)</i>
<dd><code><b>fireOnOneCallback</b></code> -
(keyword param) a flag indicating that only one callback needs
to be fired for me to call my callback
<dd><code><b>fireOnOneErrback</b></code> -
(keyword param) a flag indicating that only one errback needs
to be fired for me to call my errback
<dd><code><b>consumeErrors</b></code> -
(keyword param) a flag indicating that any errors raised in
the original deferreds should be consumed by this DeferredList.
This is useful to prevent spurious warnings being logged.
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.internet.defer.Deferred.html#__init__"><code>twisted.internet.defer.Deferred.__init__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_cbDeferred"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_cbDeferred</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>result</span>,
<span class=sig-arg>index</span>,
<span class=sig-arg>succeeded</span>)</span>
</h3>
(internal) Callback for when one of my deferreds fires.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="addDeferred"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addDeferred</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>deferred</span>)</span>
</h3>
DEPRECATED
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="fireOnOneCallback"></a>
<h3>fireOnOneCallback</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="fireOnOneErrback"></a>
<h3>fireOnOneErrback</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:55 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>