twisted.internet.interfaces.IDelayedCall.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.interfaces.IDelayedCall</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.interfaces.html">Module interfaces</a> ::
Class IDelayedCall
</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.interfaces.IDelayedCall.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IDelayedCall</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IDelayedCall</b>
</pre><br />
<hr/>
<p>A scheduled call.</p>
There are probably other useful methods we can add to this interface;
suggestions are welcome.
<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.interfaces.IDelayedCall.html#active" class="summary-sig-name"><code>active</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a bool representing whether or not this call has been called or
cancelled.</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.interfaces.IDelayedCall.html#cancel" class="summary-sig-name"><code>cancel</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Cancel the scheduled 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.interfaces.IDelayedCall.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 />
Delay the scheduled 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.interfaces.IDelayedCall.html#getTime" class="summary-sig-name"><code>getTime</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get time when delayed call will happen.</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.interfaces.IDelayedCall.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 />
Reset the scheduled call's timer.</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>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A bool representing whether or not this call has been called
or cancelled. (True == This DelayedCall has not been called or
cancelled. False, otherwise).
</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>
Cancel the scheduled call.
<dl><dt></dt><dd>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>twisted.internet.error.AlreadyCalled</b></code> -
if the call has already happened.
<dd><code><b>twisted.internet.error.AlreadyCancelled</b></code> -
if the call has already been cancelled.
</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>
Delay the scheduled call.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>secondsLater</b></code> -
how many seconds from its current firing time to delay
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>twisted.internet.error.AlreadyCalled</b></code> -
if the call has already happened.
<dd><code><b>twisted.internet.error.AlreadyCancelled</b></code> -
if the call has already been cancelled.
</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>
Get time when delayed call will happen.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
time in seconds since epoch (a float).
</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>
Reset the scheduled call's timer.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>secondsFromNow</b></code> -
how many seconds from now it should fire, equivalent to
<code>self.cancel()</code> and then doing another
<code>reactor.callLater(secondsLater, ...)</code>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>twisted.internet.error.AlreadyCalled</b></code> -
if the call has already happened.
<dd><code><b>twisted.internet.error.AlreadyCancelled</b></code> -
if the call has already been cancelled.
</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:42 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>