t.p.h.ShapedProtocolFactory : class documentation

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

I dispense Protocols with traffic shaping on their transports.

Usage:

   myserver = SomeFactory()
   myserver.protocol = ShapedProtocolFactory(myserver.protocol,
                                             bucketFilter)

Where SomeServerFactory is a twisted.internet.protocol.Factory, and bucketFilter is an instance of HierarchicalBucketFilter.

Method	__init__	Tell me what to wrap and where to get buckets.
Method	__call__	Make a Protocol instance with a shaped transport.

def __init__(self, protoClass, bucketFilter): (source)

Tell me what to wrap and where to get buckets.

Parameters	protoClass	The class of Protocol I will generate wrapped instances of. (type: `Protocol` class)
	bucketFilter	The filter which will determine how traffic is shaped. (type: `HierarchicalBucketFilter`.)

def __call__(self, *a, **kw): (source)

Make a Protocol instance with a shaped transport.

Any parameters will be passed on to the protocol's initializer.

Returns a Protocol instance with a ShapedTransport.

API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.