twisted.internet.base.DelayedCall.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.base.DelayedCall</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.base.html">Module base</a> ::
Class DelayedCall
</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.base.DelayedCall.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class DelayedCall</h2>
<pre class="base-tree">
<a href="twisted.persisted.styles.Ephemeral.html"><code>Ephemeral</code></a> --+
|
<b>DelayedCall</b>
</pre><br />
<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>time</span>,
<span class=summary-sig-arg>func</span>,
<span class=summary-sig-arg>args</span>,
<span class=summary-sig-arg>kw</span>,
<span class=summary-sig-arg>cancel</span>,
<span class=summary-sig-arg>reset</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__lt__"></a><span class="summary-sig"><span class="summary-sig-name">__lt__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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"> <code>bool</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.base.DelayedCall.html#active" class="summary-sig-name"><code>active</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Determine whether this call is still pending</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.base.DelayedCall.html#cancel" class="summary-sig-name"><code>cancel</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Unschedule this call</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.base.DelayedCall.html#delay" class="summary-sig-name"><code>delay</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>secondsLater</span>)</span></code>
<br />
Reschedule this call for a later time</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>float</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.base.DelayedCall.html#getTime" class="summary-sig-name"><code>getTime</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the time at which this call will fire</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.base.DelayedCall.html#reset" class="summary-sig-name"><code>reset</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>secondsFromNow</span>)</span></code>
<br />
Reschedule this call for a different time</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Ephemeral</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.styles.Ephemeral.html#__getstate__" class="summary-sig-name"><code>__getstate__</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.persisted.styles.Ephemeral.html#__setstate__" class="summary-sig-name"><code>__setstate__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>state</span>)</span></code>
</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>class</code></font></td>
<td><a name="__implements__"></a><b><code>__implements__</code></b> = <a href="twisted.internet.interfaces.IDelayedCall.html"><code>twisted.internet.interfaces.IDelayedCall</code></a></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.base.DelayedCall.html#debug"><code>debug</code></a></b> = <span title="0">0 </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="active"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">active</span>(<span class=sig-arg>self</span>)</span>
</h3>
Determine whether this call is still pending
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
True if this call has not yet been made or cancelled, False
otherwise.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="cancel"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cancel</span>(<span class=sig-arg>self</span>)</span>
</h3>
Unschedule this call
<dl><dt></dt><dd>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>AlreadyCancelled</b></code> -
Raised if this call has already been unscheduled.
<dd><code><b>AlreadyCalled</b></code> -
Raised if this call has already been made.
</dl>
</dd></dl>
</td></tr></table>
<a name="delay"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">delay</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>secondsLater</span>)</span>
</h3>
Reschedule this call for a later time
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>secondsLater</b></code> -
The number of seconds after the originally scheduled time for
which to reschedule this call.
<br /><i>
(type=<code>float</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>AlreadyCancelled</b></code> -
Raised if this call has been cancelled.
<dd><code><b>AlreadyCalled</b></code> -
Raised if this call has already been made.
</dl>
</dd></dl>
</td></tr></table>
<a name="getTime"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getTime</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the time at which this call will fire
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The number of seconds after the epoch at which this call is
scheduled to be made.
<br /><i>
(type=<code>float</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="reset"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">reset</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>secondsFromNow</span>)</span>
</h3>
Reschedule this call for a different time
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>secondsFromNow</b></code> -
The number of seconds from the time of the <code>reset</code>
call at which this call will be scheduled.
<br /><i>
(type=<code>float</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>AlreadyCancelled</b></code> -
Raised if this call has been cancelled.
<dd><code><b>AlreadyCalled</b></code> -
Raised if this call has already been made.
</dl>
</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="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 </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:08:03 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>