twisted.internet.interfaces.IReactorCore.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.IReactorCore</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 IReactorCore
</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.IReactorCore.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IReactorCore</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IReactorCore</b>
</pre><br />
<hr/>
Core methods that a Reactor must 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.IReactorCore.html#addSystemEventTrigger" class="summary-sig-name"><code>addSystemEventTrigger</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>phase</span>,
<span class=summary-sig-arg>eventType</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 />
Add a function to be called when a system event occurs.</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.IReactorCore.html#callWhenRunning" class="summary-sig-name"><code>callWhenRunning</code></a>(<span class=summary-sig-arg>self</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 when the reactor is running.</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.IReactorCore.html#crash" class="summary-sig-name"><code>crash</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Stop the main loop *immediately*, without firing any system
events.</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.IReactorCore.html#fireSystemEvent" class="summary-sig-name"><code>fireSystemEvent</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>eventType</span>)</span></code>
<br />
Fire a system-wide event.</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.IReactorCore.html#iterate" class="summary-sig-name"><code>iterate</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>delay</span>)</span></code>
<br />
Run the main loop's I/O polling function for a period of time.</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.IReactorCore.html#removeSystemEventTrigger" class="summary-sig-name"><code>removeSystemEventTrigger</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>triggerID</span>)</span></code>
<br />
Removes a trigger added with addSystemEventTrigger.</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.IReactorCore.html#resolve" class="summary-sig-name"><code>resolve</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>timeout</span>)</span></code>
<br />
Return a <a href="twisted.internet.defer.Deferred.html"
class="link"><code>twisted.internet.defer.Deferred</code></a> that will
resolve a hostname.</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.IReactorCore.html#run" class="summary-sig-name"><code>run</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Fire 'startup' System Events, move the reactor to the 'running' state,
then run the main loop until it is stopped with stop() or crash().</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.IReactorCore.html#stop" class="summary-sig-name"><code>stop</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Fire 'shutdown' System Events, which will move the reactor to the
'stopped' state and cause reactor.run() to exit.</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="addSystemEventTrigger"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addSystemEventTrigger</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>phase</span>,
<span class=sig-arg>eventType</span>,
<span class=sig-arg>callable</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
<p>Add a function to be called when a system event occurs.</p>
<p>Each "system event" in Twisted, such as 'startup',
'shutdown', and 'persist', has 3 phases: 'before', 'during', and
'after' (in that order, of course). These events will be fired
internally by the Reactor.</p>
<p>An implementor of this interface must only implement those events
described here.</p>
<p>Callbacks registered for the "before" phase may return
either None or a Deferred. The "during" phase will not
execute until all of the Deferreds from the "before" phase
have fired.</p>
Once the "during" phase is running, all of the remaining
triggers must execute; their return values must be ignored.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>phase</b></code> -
a time to call the event -- either the string 'before',
'after', or 'during', describing when to call it relative to the
event's execution.
<dd><code><b>eventType</b></code> -
this is a string describing the type of event.
<dd><code><b>callable</b></code> -
the object to call before shutdown.
<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 ID that can be used to remove this call with
removeSystemEventTrigger.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="callWhenRunning"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">callWhenRunning</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>callable</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
<p>Call a function when the reactor is running.</p>
If the reactor has not started, the callable will be scheduled to
run when it does start. Otherwise, the callable will be invoked
immediately.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<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>
None if the callable was invoked, otherwise a system event id
for the scheduled call.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="crash"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">crash</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Stop the main loop *immediately*, without firing any system
events.</p>
This is named as it is because this is an extremely "rude"
thing to do; it is possible to lose data and put your system in an
inconsistent state by calling this. However, it is necessary, as
sometimes a system can become wedged in a pre-shutdown call.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="fireSystemEvent"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fireSystemEvent</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>eventType</span>)</span>
</h3>
<p>Fire a system-wide event.</p>
System-wide events are things like 'startup', 'shutdown', and
'persist'.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="iterate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">iterate</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>delay</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Run the main loop's I/O polling function for a period of time.</p>
This is most useful in applications where the UI is being drawn
"as fast as possible", such as games. All pending <a
href="twisted.internet.interfaces.IDelayedCall.html"
class="link"><code>IDelayedCall</code></a>s will be called.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="removeSystemEventTrigger"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">removeSystemEventTrigger</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>triggerID</span>)</span>
</h3>
Removes a trigger added with addSystemEventTrigger.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>triggerID</b></code> -
a value returned from addSystemEventTrigger.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="resolve"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">resolve</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>,
<span class=sig-arg>timeout</span>=<span class=sig-default>10</span>)</span>
</h3>
Return a <a href="twisted.internet.defer.Deferred.html"
class="link"><code>twisted.internet.defer.Deferred</code></a> that will
resolve a hostname.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="run"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">run</span>(<span class=sig-arg>self</span>)</span>
</h3>
Fire 'startup' System Events, move the reactor to the 'running'
state, then run the main loop until it is stopped with stop() or
crash().
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="stop"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">stop</span>(<span class=sig-arg>self</span>)</span>
</h3>
Fire 'shutdown' System Events, which will move the reactor to the
'stopped' state and cause reactor.run() to exit.
<dl><dt></dt><dd>
</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:45 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>