twisted.protocols.htb.HierarchicalBucketFilter.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.protocols.htb.HierarchicalBucketFilter</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.protocols.html">Package protocols</a> ::
<a href="twisted.protocols.htb.html">Module htb</a> ::
Class HierarchicalBucketFilter
</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.protocols.htb.HierarchicalBucketFilter.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class HierarchicalBucketFilter</h2>
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.protocols.htb.FilterByHost.html"><code>FilterByHost</code></a>,
<a href="twisted.protocols.htb.FilterByServer.html"><code>FilterByServer</code></a></dd></dl>
<hr/>
I filter things into buckets, and I am nestable.
<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>parentFilter</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="twisted.protocols.htb.Bucket.html"
class="link"><code>Bucket</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.htb.HierarchicalBucketFilter.html#getBucketFor" class="summary-sig-name"><code>getBucketFor</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*a</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
You want a bucket for that? I'll give you a bucket.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.htb.HierarchicalBucketFilter.html#getBucketKey" class="summary-sig-name"><code>getBucketKey</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*a</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
I determine who gets which bucket.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.htb.HierarchicalBucketFilter.html#sweep" class="summary-sig-name"><code>sweep</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
I throw away references to empty buckets.</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>tuple</code></font></td>
<td><b><a href="twisted.protocols.htb.HierarchicalBucketFilter.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.protocols.htb.IBucketFilter at 0x8765fb4>,)"><code>(<class twisted.protocols.htb.IBucketFi<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="twisted.protocols.htb.Bucket.html"
class="link"><code>Bucket</code></a> class</font></td>
<td><a name="bucketFactory"></a><b><code>bucketFactory</code></b> = <a href="twisted.protocols.htb.Bucket.html"><code>twisted.protocols.htb.Bucket</code></a></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">int</font></td>
<td><b><a href="twisted.protocols.htb.HierarchicalBucketFilter.html#sweepInterval"><code>sweepInterval</code></a></b>: Seconds between sweeping out the bucket cache.</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="getBucketFor"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getBucketFor</span>(<span class=sig-arg>self</span>,
<span class="sig-vararg">*a</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
<p>You want a bucket for that? I'll give you a bucket.</p>
Any parameters are passed on to <a
href="twisted.protocols.htb.HierarchicalBucketFilter.html#getBucketKey"
class="link"><code>getBucketKey</code></a>, from them it decides which
bucket you get.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="twisted.protocols.htb.Bucket.html"
class="link"><code>Bucket</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getBucketKey"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getBucketKey</span>(<span class=sig-arg>self</span>,
<span class="sig-vararg">*a</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
<p>I determine who gets which bucket.</p>
Unless I'm overridden, everything gets the same bucket.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
something to be used as a key in the bucket cache.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="sweep"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">sweep</span>(<span class=sig-arg>self</span>)</span>
</h3>
I throw away references to empty buckets.
<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="__implements__"></a>
<h3>__implements__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>tuple</code>
</dd>
<span title="(<class twisted.protocols.htb.IBucketFilter at 0x8765fb4>,)"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
(<class twisted.protocols.htb.IBucketFilter at 0x8765fb4>,) </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="sweepInterval"></a>
<h3>sweepInterval</h3>
Seconds between sweeping out the bucket cache.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
int
</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>
<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:34 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>