twisted.flow.controller.Deferred.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.flow.controller.Deferred</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.flow.html">Package flow</a> ::
<a href="twisted.flow.controller.html">Module controller</a> ::
Class Deferred
</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.flow.controller.Deferred.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Deferred</h2>
<pre class="base-tree">
<a href="twisted.flow.base.Controller.html"><code>Controller</code></a> --+
|
<a href="twisted.internet.defer.Deferred.html"><code>Deferred</code></a> --+
|
<b>Deferred</b>
</pre><br />
<hr/>
<pre class="literalblock">
wraps up a Stage with a Deferred interface
In this version, the results of the Stage are used to
construct a list of results and then sent to deferred. Further,
in this version Cooperate is implemented via reactor's callLater.
from twisted.internet import reactor
from twisted.flow import flow
def res(x): print x
d = flow.Deferred([1,2,3])
d.addCallback(res)
reactor.iterate()
</pre>
<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>stage</span>,
<span class="summary-sig-vararg">*trap</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_execute"></a><span class="summary-sig"><span class="summary-sig-name">_execute</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>dummy</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="results"></a><span class="summary-sig"><span class="summary-sig-name">results</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>results</span>)</span></code>
</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 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 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:08:36 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>