t.p.h.HierarchicalBucketFilter : class documentation

Part of twisted.protocols.htb View Source View In Hierarchy

Known subclasses: twisted.protocols.htb.FilterByHost, twisted.protocols.htb.FilterByServer

Implements interfaces: twisted.protocols.htb.IBucketFilter

I filter things into buckets, and I am nestable.
Class Variable bucketFactory Class of buckets to make. (type: Bucket class)
Class Variable sweepInterval Seconds between sweeping out the bucket cache. (type: int)
Method __init__ Undocumented
Method getBucketFor You want a bucket for that? I'll give you a bucket.
Method getBucketKey I determine who gets which bucket.
Method sweep I throw away references to empty buckets.
bucketFactory =
Class of buckets to make. (type: Bucket class)
sweepInterval =
Seconds between sweeping out the bucket cache. (type: int)
def __init__(self, parentFilter=None): (source)
Undocumented
def getBucketFor(self, *a, **kw): (source)
You want a bucket for that? I'll give you a bucket.

Any parameters are passed on to getBucketKey, from them it decides which bucket you get.

Returns (type: Bucket)
def getBucketKey(self, *a, **kw): (source)
I determine who gets which bucket.

Unless I'm overridden, everything gets the same bucket.

Returnssomething to be used as a key in the bucket cache.
def sweep(self): (source)
I throw away references to empty buckets.
API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.