twisted.python.threadable.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.python.threadable</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.python.html">Package python</a> ::
Module threadable
</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.python.threadable.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.python.threadable</h2>
A module that will allow your program to be multi-threaded,
micro-threaded, and single-threaded. Currently microthreads are
unimplemented. The idea is to abstract away some commonly used
functionality so that I don't have to special-case it in all
programs.
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.python.threadable._ThreadedWaiter.html"><code>_ThreadedWaiter</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.python.threadable._Waiter.html"><code>_Waiter</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.python.threadable._XLock.html"><code>_XLock</code></a></b></td>
<td>Exclusive lock class.</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.threadable._ThreadedWaiter.html"><code>Waiter</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.python.threadable._XLock.html"><code>XLock</code></a></b></td>
<td>Exclusive lock class.</td></tr>
</table><br />
<!-- =========== START OF EXCEPTIONS =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Exceptions</th></tr>
<tr><td width="15%">
<b><a href="twisted.python.threadable.ThreadableError.html"><code>ThreadableError</code></a></b></td>
<td> </td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_synchPost"></a><span class="summary-sig"><span class="summary-sig-name">_synchPost</span>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*a</span>,
<span class="summary-sig-kwarg">**b</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_synchPre"></a><span class="summary-sig"><span class="summary-sig-name">_synchPre</span>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*a</span>,
<span class="summary-sig-kwarg">**b</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.python.threadable.html#init" class="summary-sig-name"><code>init</code></a>(<span class=summary-sig-arg>with_threads</span>)</span></code>
<br />
Initialize threading.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.threadable.html#isInIOThread" class="summary-sig-name"><code>isInIOThread</code></a>()</span></code>
<br />
Are we in the thread responsable for I/O requests (the event
loop)?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.threadable.html#registerAsIOThread" class="summary-sig-name"><code>registerAsIOThread</code></a>()</span></code>
<br />
Mark the current thread as responsable for I/O requests.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.threadable.html#synchronize" class="summary-sig-name"><code>synchronize</code></a>(<span class="summary-sig-vararg">*klasses</span>)</span></code>
<br />
Make all methods listed in each class' synchronized attribute
synchronized.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="whenThreaded"></a><span class="summary-sig"><span class="summary-sig-name">whenThreaded</span>(<span class=summary-sig-arg>cb</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.python.threadable.html#_to_be_synched"><code>_to_be_synched</code></a></b> = <span title="[]"><code>[] </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.python.threadable.html#ioThread"><code>ioThread</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.python.threadable.html#threadCallbacks"><code>threadCallbacks</code></a></b> = <span title="[<function initThreads at 0x81d40ac>, <function initThreads at 0x81e739c>, <bound method SelectReactor.initThreads of <twisted.internet.default.SelectReactor instance at 0x825d6ac>>]"><code>[<function initThreads at 0x81d40ac>, <span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.python.threadable.html#threaded"><code>threaded</code></a></b> = <span title="1">1 </span></td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="init"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">init</span>(<span class=sig-arg>with_threads</span>=<span class=sig-default>1</span>)</span>
</h3>
Initialize threading. Should be run once, at the beginning of
program.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="isInIOThread"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">isInIOThread</span>()</span>
</h3>
Are we in the thread responsable for I/O requests (the event
loop)?
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="registerAsIOThread"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">registerAsIOThread</span>()</span>
</h3>
Mark the current thread as responsable for I/O requests.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="synchronize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">synchronize</span>(<span class="sig-vararg">*klasses</span>)</span>
</h3>
<p>Make all methods listed in each class' synchronized attribute
synchronized.</p>
The synchronized attribute should be a list of strings, consisting
of the names of methods that must be synchronized. If we are running in
threaded mode these methods will be wrapped with a lock.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_to_be_synched"></a>
<h3>_to_be_synched</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="ioThread"></a>
<h3>ioThread</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 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="threadCallbacks"></a>
<h3>threadCallbacks</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[<function initThreads at 0x81d40ac>, <function initThreads at 0x81e739c>, <bound method SelectReactor.initThreads of <twisted.internet.default.SelectReactor instance at 0x825d6ac>>]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[<function initThreads at 0x81d40ac>,
<function initThreads at 0x81e739c>,
<bound method SelectReactor.initThreads of <twisted.internet.default.<span class="variable-linewrap">\</span>
SelectReactor instance at 0x825d6ac>>] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="threaded"></a>
<h3>threaded</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="1"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
1 </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:14 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>