twisted.protocols.htb.ShapedProtocolFactory

class documentation

class ShapedProtocolFactory: (source)

View In Hierarchy

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 __call__ Make a Protocol instance with a shaped transport.
Method __init__ Tell me what to wrap and where to get buckets.
Instance Variable bucket​Filter Undocumented
Instance Variable protocol Undocumented
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.
def __init__(self, protoClass, bucketFilter): (source)
Tell me what to wrap and where to get buckets.
Parameters
proto​Class:Protocol classThe class of Protocol this will generate wrapped instances of.
bucket​Filter:HierarchicalBucketFilter.The filter which will determine how traffic is shaped.
bucketFilter = (source)

Undocumented

protocol = (source)

Undocumented