twisted.protocols.htb.ShapedProtocolFactory class documentation

Part of twisted.protocols.htb (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 __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):

Tell me what to wrap and where to get buckets.

ParametersprotoClassThe class of Protocol this will generate wrapped instances of. (type: Protocol class)
bucketFilterThe filter which will determine how traffic is shaped. (type: HierarchicalBucketFilter.)
def __call__(self, *a, **kw):

Make a Protocol instance with a shaped transport.

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

ReturnsA Protocol instance with a ShapedTransport.
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.