twisted.internet.defer.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.internet.defer.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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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&nbsp;twisted</a> ::
        <a href="twisted.internet.html">Package&nbsp;internet</a> ::
        <a href="twisted.internet.defer.html">Module&nbsp;defer</a> ::
        Class&nbsp;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>&nbsp;|&nbsp;<a href="twisted.internet.defer.Deferred.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Deferred</h2>

<dl><dt><b>Known Subclasses:</b></dt>
<dd>
    <a href="twisted.persisted.crefutil._Defer.html"><code>_Defer</code></a>,
    <a href="twisted.flow.controller.Deferred.html"><code>Deferred</code></a>,
    <a href="twisted.internet.defer.DeferredList.html"><code>DeferredList</code></a></dd></dl>

<hr/>

<p>This is a callback which will be put off until later.</p>
<p>Why do we want this? Well, in cases where a function in a threaded 
program would block until it gets a result, for Twisted it should not 
block. Instead, it should return a Deferred.</p>
<p>This can be implemented for protocols that run over the network by 
writing an asynchronous protocol for twisted.internet. For methods that 
come from outside packages that are not under our control, we use threads 
(see for example <a href="twisted.enterprise.adbapi.html" 
class="link"><code>twisted.enterprise.adbapi</code></a>).</p>
For more information about Deferreds, see doc/howto/defer.html or <a 
href="http://www.twistedmatrix.com/documents/howto/defer">http://www.twistedmatrix.com/documents/howto/defer</a>
<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">&nbsp;</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></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</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">&nbsp;</font></td>
  <td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="_continue"></a><span class="summary-sig"><span class="summary-sig-name">_continue</span>(<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">&nbsp;</font></td>
  <td><code><a name="_debugInfo"></a><span class="summary-sig"><span class="summary-sig-name">_debugInfo</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="_runCallbacks"></a><span class="summary-sig"><span class="summary-sig-name">_runCallbacks</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="_startRunCallbacks"></a><span class="summary-sig"><span class="summary-sig-name">_startRunCallbacks</span>(<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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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.Deferred.html#called"><code>called</code></a></b> = <span title="0">0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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="__del__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">__del__</span>(<span class=sig-arg>self</span>)</span>
    <br /><i>(Destructor)</i>
  </h3>
  <p>Print tracebacks and die.</p>
  If the *last* (and I do mean *last*) callback leaves me in an error 
  state, print a traceback (if said errback is a Failure).
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="addBoth"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">addBoth</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>callback</span>,
          <span class="sig-vararg">*args</span>,
          <span class="sig-kwarg">**kw</span>)</span>
  </h3>
  <p>Convenience method for adding a single callable as both a callback 
  and an errback.</p>
  See <a href="twisted.internet.defer.Deferred.html#addCallbacks" 
  class="link"><code>addCallbacks</code></a>.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="addCallback"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">addCallback</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>callback</span>,
          <span class="sig-vararg">*args</span>,
          <span class="sig-kwarg">**kw</span>)</span>
  </h3>
  <p>Convenience method for adding just a callback.</p>
  See <a href="twisted.internet.defer.Deferred.html#addCallbacks" 
  class="link"><code>addCallbacks</code></a>.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="addCallbacks"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">addCallbacks</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>callback</span>,
          <span class=sig-arg>errback</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>callbackArgs</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>callbackKeywords</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>errbackArgs</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>errbackKeywords</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>asDefaults</span>=<span class=sig-default>0</span>)</span>
  </h3>
  <p>Add a pair of callbacks (success and error) to this Deferred.</p>
  These will be executed when the 'master' callback is run.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="addErrback"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">addErrback</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>errback</span>,
          <span class="sig-vararg">*args</span>,
          <span class="sig-kwarg">**kw</span>)</span>
  </h3>
  <p>Convenience method for adding just an errback.</p>
  See <a href="twisted.internet.defer.Deferred.html#addCallbacks" 
  class="link"><code>addCallbacks</code></a>.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="arm"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">arm</span>(<span class=sig-arg>self</span>)</span>
  </h3>
  This method is deprecated.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="callback"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">armAndCallback</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>result</span>)</span>
  </h3>
  <p>Run all success callbacks that have been added to this Deferred.</p>
  Each callback will have its result passed as the first argument to 
  the next; this way, the callbacks act as a 'processing chain'. Also, if 
  the success-callback returns a Failure or raises an Exception, 
  processing will continue on the *error*- callback chain.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="chainDeferred"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">armAndChain</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>d</span>)</span>
  </h3>
  <p>Chain another Deferred to this Deferred.</p>
  This method adds callbacks to this Deferred to call d's callback or 
  errback, as appropriate.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="errback"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">armAndErrback</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>fail</span>=<span class=sig-default>None</span>)</span>
  </h3>
  <p>Run all error callbacks that have been added to this Deferred.</p>
  <p>Each callback will have its result passed as the first argument to 
  the next; this way, the callbacks act as a 'processing chain'. Also, if 
  the error-callback returns a non-Failure or doesn't raise an Exception, 
  processing will continue on the *success*-callback chain.</p>
  <p>If the argument that's passed to me is not a failure.Failure 
  instance, it will be embedded in one. If no argument is passed, a 
  failure.Failure instance will be created based on the current traceback 
  stack.</p>
  Passing a string as `fail' is deprecated, and will be punished with 
  a warning message.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="callback"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">callback</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>result</span>)</span>
  </h3>
  <p>Run all success callbacks that have been added to this Deferred.</p>
  Each callback will have its result passed as the first argument to 
  the next; this way, the callbacks act as a 'processing chain'. Also, if 
  the success-callback returns a Failure or raises an Exception, 
  processing will continue on the *error*- callback chain.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="chainDeferred"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">chainDeferred</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>d</span>)</span>
  </h3>
  <p>Chain another Deferred to this Deferred.</p>
  This method adds callbacks to this Deferred to call d's callback or 
  errback, as appropriate.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="errback"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">errback</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>fail</span>=<span class=sig-default>None</span>)</span>
  </h3>
  <p>Run all error callbacks that have been added to this Deferred.</p>
  <p>Each callback will have its result passed as the first argument to 
  the next; this way, the callbacks act as a 'processing chain'. Also, if 
  the error-callback returns a non-Failure or doesn't raise an Exception, 
  processing will continue on the *success*-callback chain.</p>
  <p>If the argument that's passed to me is not a failure.Failure 
  instance, it will be embedded in one. If no argument is passed, a 
  failure.Failure instance will be created based on the current traceback 
  stack.</p>
  Passing a string as `fail' is deprecated, and will be punished with 
  a warning message.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="pause"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">pause</span>(<span class=sig-arg>self</span>)</span>
  </h3>
  Stop processing on a Deferred until <a 
  href="twisted.internet.defer.Deferred.html#unpause" 
  class="link"><code>unpause</code></a>() is called.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="setTimeout"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">setTimeout</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>seconds</span>,
          <span class=sig-arg>timeoutFunc</span>=<span class=sig-default>&lt;function&nbsp;timeout&nbsp;at&nbsp;0x82a90c4&gt;</span>,
          <span class="sig-vararg">*args</span>,
          <span class="sig-kwarg">**kw</span>)</span>
  </h3>
  Set a timeout function to be triggered if I am not called.
  <dl><dt></dt><dd>
    <dl><dt><b>Parameters:</b></dt>
      <dd><code><b>seconds</b></code> -
         How long to wait (from now) before firing the timeoutFunc.
      <dd><code><b>timeoutFunc</b></code> -
         <p>will receive the Deferred and *args, **kw as its arguments. 
        The default timeoutFunc will call the errback with a <a 
        href="twisted.internet.defer.TimeoutError.html" 
        class="link"><code>TimeoutError</code></a>.</p>
        <p>DON'T USE THIS! It's a bad idea! Use a function called by 
        reactor.callLater instead to accomplish the same thing!</p>
        YOU HAVE BEEN WARNED!
      </dd>
    </dl>
  </dd></dl>
</td></tr></table>

<a name="unpause"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">unpause</span>(<span class=sig-arg>self</span>)</span>
  </h3>
  Process all callbacks made since <a 
  href="twisted.internet.defer.Deferred.html#pause" 
  class="link"><code>pause</code></a>() was called.
  <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="called"></a>
<h3>called</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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
        </td></tr></table></dd>
</span>    </dl>
  </dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="debug"></a>
<h3>debug</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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
        </td></tr></table></dd>
</span>    </dl>
  </dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="default"></a>
<h3>default</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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
        </td></tr></table></dd>
</span>    </dl>
  </dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="paused"></a>
<h3>paused</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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
        </td></tr></table></dd>
</span>    </dl>
  </dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="timeoutCall"></a>
<h3>timeoutCall</h3>
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <code>NoneType</code>

      </dd>
<span title="None">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
None&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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:57 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>