t.p.h.Bucket : class documentation

Token bucket, or something like it.

I can hold up to a certain number of tokens, and I drain over time.

Class Variables	maxburst	Size of the bucket, in bytes. If None, the bucket is never full. (type: int )
	rate	Rate the bucket drains, in bytes per second. If None, the bucket drains instantaneously. (type: int )

def __init__(self, parentBucket=None): (source)

Undocumented

def add(self, amount): (source)

Add tokens to me.

Parameters	amount	A quanity of tokens to add. (type: int )
Returns	The number of tokens that fit. (type: int )

def drip(self): (source)

Let some of the bucket drain.

How much of the bucket drains depends on how long it has been since I was last called.

Returns True if I am now empty. (type: bool )

API Documentation for Twisted, generated by pydoctor at 2011-04-03 00:32:03.