twisted.protocols.htb.ShapedConsumer

class documentation

class ShapedConsumer(pcp.ProducerConsumerProxy): (source)

Known subclasses: twisted.protocols.htb.ShapedTransport

View In Hierarchy

Wraps a Consumer and shapes the rate at which it receives data.
Method __init__ Undocumented
Method stop​Producing Stop producing data.
Class Variable i​Am​Streaming Undocumented
Instance Variable bucket Undocumented
Method _write​Some​Data Write as much of this data as possible.

Inherited from ProducerConsumerProxy:

Method pause​Producing Undocumented
Method register​Producer Register to receive data from a producer.
Method resume​Producing Undocumented
Method unregister​Producer Stop consuming data from a producer, without disconnecting.
Method write The producer will write data by calling this method.
Class Variable buffer​Size Undocumented
Instance Variable outstanding​Pull Undocumented
Instance Variable paused Undocumented
Instance Variable producer​Paused Undocumented
Instance Variable unregistered Undocumented

Inherited from BasicProducerConsumerProxy (via ProducerConsumerProxy):

Method __repr__ Undocumented
Method finish Undocumented
Class Variable stopped Undocumented
Instance Variable consumer the Consumer I publish to.
Instance Variable producer the Producer I subscribe to.
Instance Variable producer​Is​Streaming Undocumented
Instance Variable _buffer Undocumented
def __init__(self, consumer, bucket): (source)
overrides twisted.protocols.pcp.BasicProducerConsumerProxy.__init__

Undocumented

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.

iAmStreaming: bool = (source)
overrides twisted.protocols.pcp.BasicProducerConsumerProxy.iAmStreaming
overridden in twisted.protocols.htb.ShapedTransport

Undocumented

bucket = (source)

Undocumented

def _writeSomeData(self, data): (source)
overrides twisted.protocols.pcp.ProducerConsumerProxy._writeSomeData
Write as much of this data as possible.
Returns
The number of bytes written.