twisted.internet.interfaces.IReactorTime.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.IReactorTime</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 IReactorTime
</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.IReactorTime.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IReactorTime</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IReactorTime</b>
</pre><br />
<hr/>
Time methods that a Reactor should implement.
<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.IReactorTime.html#callLater" class="summary-sig-name"><code>callLater</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>delay</span>,
<span class=summary-sig-arg>callable</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Call a function later.</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.IReactorTime.html#cancelCallLater" class="summary-sig-name"><code>cancelCallLater</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>callID</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.interfaces.IReactorTime.html#getDelayedCalls" class="summary-sig-name"><code>getDelayedCalls</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Retrieve a list of all delayed calls.</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="callLater"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">callLater</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>delay</span>,
<span class=sig-arg>callable</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
Call a function later.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>delay</b></code> -
the number of seconds to wait.
<br /><i>
(type=<code>float</code>)</i>
<dd><code><b>callable</b></code> -
the callable object to call later.
<dd><code><b>args</b></code> -
the arguments to call it with.
<dd><code><b>kw</b></code> -
the keyword arguments to call it with.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
An <a href="twisted.internet.interfaces.IDelayedCall.html"
class="link"><code>IDelayedCall</code></a> object that can be
used to cancel the scheduled call, by calling its
<code>cancel()</code> method. It also may be rescheduled by
calling its <code>delay()</code> or <code>reset()</code>
methods.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="cancelCallLater"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cancelCallLater</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>callID</span>)</span>
</h3>
<p>This method is deprecated.</p>
Cancel a call that would happen later.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>callID</b></code> -
this is an opaque identifier returned from
<code>callLater</code> that will be used to cancel a specific
call.
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ValueError</b></code> -
if the callID is not recognized.
</dl>
</dd></dl>
</td></tr></table>
<a name="getDelayedCalls"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getDelayedCalls</span>(<span class=sig-arg>self</span>)</span>
</h3>
Retrieve a list of all delayed calls.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A tuple of all <a
href="twisted.internet.interfaces.IDelayedCall.html"
class="link"><code>IDelayedCall</code></a> objects that are
currently scheduled. This is everything that has been returned by
<code>callLater</code> but not yet called or canceled.
</dd>
</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:41 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>