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

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

Known subclasses: twisted.protocols.htb.ShapedTransport

I wrap a Consumer and shape 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):

Method finish Undocumented
Method __repr__ Undocumented
def __init__(self, consumer, bucket): (source)
overrides twisted.protocols.pcp.BasicProducerConsumerProxy.__init__
Undocumented
def _writeSomeData(self, data): (source)
overrides twisted.protocols.pcp.ProducerConsumerProxy._writeSomeData
Write as much of this data as possible.
ReturnsThe number of bytes written.
def stopProducing(self): (source)
from twisted.internet.interfaces.IProducer
overrides twisted.protocols.pcp.BasicProducerConsumerProxy.stopProducing

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 2011-10-27 16:17:34.