t.p.h.ShapedConsumer(pcp.ProducerConsumerProxy) : class documentation

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

Known subclasses: twisted.protocols.htb.ShapedTransport

Wraps a Consumer and shapes the rate at which it receives data.
Method __init__ Undocumented
Method stopProducing Stop producing data.
Method _writeSomeData Write as much of this data as possible.

Inherited from ProducerConsumerProxy:

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 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 __init__(self, consumer, bucket): (source)
Undocumented
def _writeSomeData(self, data): (source)
Write as much of this data as possible.
ReturnsThe number of bytes written.
def stopProducing(self): (source)
Stop producing data.

This tells a producer that its consumer has died, so it must stop producing data for good.

API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.