twisted.python.threadpool.ThreadPool.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.threadpool.ThreadPool</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> ::
<a href="twisted.python.threadpool.html">Module threadpool</a> ::
Class ThreadPool
</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.threadpool.ThreadPool.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class ThreadPool</h2>
<hr/>
<p>This class (hopefully) generalizes the functionality of a pool of
threads to which work can be dispatched.</p>
dispatch(), dispatchWithCallback() and stop() should only be called
from a single thread, unless you make a subclass where stop() and
_startSomeWorkers() are synchronized.
<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.python.threadpool.ThreadPool.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>minthreads</span>,
<span class=summary-sig-arg>maxthreads</span>)</span></code>
<br />
Create a new threadpool.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__getstate__"></a><span class="summary-sig"><span class="summary-sig-name">__getstate__</span>(<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><a name="__setstate__"></a><span class="summary-sig"><span class="summary-sig-name">__setstate__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>state</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_runWithCallback"></a><span class="summary-sig"><span class="summary-sig-name">_runWithCallback</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>callback</span>,
<span class=summary-sig-arg>errback</span>,
<span class=summary-sig-arg>func</span>,
<span class=summary-sig-arg>args</span>,
<span class=summary-sig-arg>kwargs</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_startSomeWorkers"></a><span class="summary-sig"><span class="summary-sig-name">_startSomeWorkers</span>(<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><a name="_worker"></a><span class="summary-sig"><span class="summary-sig-name">_worker</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>o</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="adjustPoolsize"></a><span class="summary-sig"><span class="summary-sig-name">adjustPoolsize</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>minthreads</span>,
<span class=summary-sig-arg>maxthreads</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="callInThread"></a><span class="summary-sig"><span class="summary-sig-name">callInThread</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>func</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</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.threadpool.ThreadPool.html#dispatch" class="summary-sig-name"><code>dispatch</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>owner</span>,
<span class=summary-sig-arg>func</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Dispatch a function to be a run in a thread.</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.threadpool.ThreadPool.html#dispatchWithCallback" class="summary-sig-name"><code>dispatchWithCallback</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>owner</span>,
<span class=summary-sig-arg>callback</span>,
<span class=summary-sig-arg>errback</span>,
<span class=summary-sig-arg>func</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Dispatch a function, returning the result to a callback function.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="dumpStats"></a><span class="summary-sig"><span class="summary-sig-name">dumpStats</span>(<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.python.threadpool.ThreadPool.html#start" class="summary-sig-name"><code>start</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Start the threadpool.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="startAWorker"></a><span class="summary-sig"><span class="summary-sig-name">startAWorker</span>(<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.python.threadpool.ThreadPool.html#stop" class="summary-sig-name"><code>stop</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Shutdown the threads in the threadpool.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="stopAWorker"></a><span class="summary-sig"><span class="summary-sig-name">stopAWorker</span>(<span class=summary-sig-arg>self</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>int</code></font></td>
<td><b><a href="twisted.python.threadpool.ThreadPool.html#__inited"><code>_ThreadPool__inited</code></a></b> = <span title="0">0 </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.threadpool.ThreadPool.html#joined"><code>joined</code></a></b> = <span title="0">0 </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.threadpool.ThreadPool.html#max"><code>max</code></a></b> = <span title="20">20 </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.threadpool.ThreadPool.html#min"><code>min</code></a></b> = <span title="5">5 </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.threadpool.ThreadPool.html#started"><code>started</code></a></b> = <span title="0">0 </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.threadpool.ThreadPool.html#workers"><code>workers</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="__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>self</span>,
<span class=sig-arg>minthreads</span>=<span class=sig-default>5</span>,
<span class=sig-arg>maxthreads</span>=<span class=sig-default>20</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Create a new threadpool.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>minthreads</b></code> -
minimum number of threads in the pool
<dd><code><b>maxthreads</b></code> -
maximum number of threads in the pool
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="dispatch"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">dispatch</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>owner</span>,
<span class=sig-arg>func</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
Dispatch a function to be a run in a thread.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="dispatchWithCallback"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">dispatchWithCallback</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>owner</span>,
<span class=sig-arg>callback</span>,
<span class=sig-arg>errback</span>,
<span class=sig-arg>func</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
<p>Dispatch a function, returning the result to a callback
function.</p>
The callback function will be called in the thread - make sure it is
thread-safe.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="start"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">start</span>(<span class=sig-arg>self</span>)</span>
</h3>
Start the threadpool.
<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>
Shutdown the threads in the threadpool.
<dl><dt></dt><dd>
</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="_ThreadPool__inited"></a>
<h3>_ThreadPool__inited</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>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="joined"></a>
<h3>joined</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>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="max"></a>
<h3>max</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="20"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
20 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="min"></a>
<h3>min</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="5"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
5 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="started"></a>
<h3>started</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>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="workers"></a>
<h3>workers</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:07:44 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>