twisted.protocols.htb.ShapedConsumer(pcp.ProducerConsumerProxy) class documentation

Part of twisted.protocols.htb (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):
overrides twisted.protocols.pcp.BasicProducerConsumerProxy.__init__
Undocumented
def _writeSomeData(self, data):
overrides twisted.protocols.pcp.ProducerConsumerProxy._writeSomeData

Write as much of this data as possible.

ReturnsThe number of bytes written.
def stopProducing(self):
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 2020-03-25 17:34:30.