t.p.h.ShapedTransport(ShapedConsumer) : class documentation

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

Wraps a Transport and shapes the rate at which it receives data.

This is a ShapedConsumer with a little bit of magic to provide for the case where the consumer it wraps is also a Transport and people will be attempting to access attributes this does not proxy as a Consumer (e.g. loseConnection).

Method __getattr__ Undocumented

Inherited from ShapedConsumer:

Method __init__ Undocumented
Method stopProducing Stop producing data.
Method _writeSomeData Write as much of this data as possible.

Inherited from ProducerConsumerProxy (via ShapedConsumer):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method write The producer will write data by calling this method.
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.

Inherited from BasicProducerConsumerProxy (via ShapedConsumer, ProducerConsumerProxy):

Instance Variable producer the Producer I subscribe to. (type: IProducer)
Instance Variable consumer the Consumer I publish to. (type: IConsumer)
Instance Variable paused As a Producer, am I paused? (type: bool)
Method finish Undocumented
Method __repr__ Undocumented
def __getattr__(self, name): (source)
API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.