class documentation

class twisted.protocols.pcp.ProducerConsumerProxy(BasicProducerConsumerProxy): (source)

Known subclasses: twisted.protocols.htb.ShapedConsumer

View In Hierarchy

ProducerConsumerProxy with a finite buffer.

When my buffer fills up, I have my parent Producer pause until my buffer has room in it again.

Class Variable bufferSize Undocumented
Instance Variable producerPaused Undocumented
Instance Variable unregistered Undocumented
Method pauseProducing Undocumented
Instance Variable paused Undocumented
Method resumeProducing Undocumented
Instance Variable outstandingPull 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.
Method _writeSomeData Write as much of this data as possible.

Inherited from BasicProducerConsumerProxy:

Instance Variable producer the Producer I subscribe to.
Instance Variable consumer the Consumer I publish to.
Instance Variable producerIsStreaming Undocumented
Class Variable iAmStreaming Undocumented
Class Variable stopped Undocumented
Method __init__ Undocumented
Method stopProducing Stop producing data.
Method finish Undocumented
Method __repr__ Undocumented
Instance Variable _buffer Undocumented
bufferSize = (source)

Undocumented

producerPaused = (source)

Undocumented

(type: bool)
unregistered = (source)

Undocumented

(type: bool)
def write(self, data): (source)

The producer will write data by calling this method.

The implementation must be non-blocking and perform whatever buffering is necessary. If the producer has provided enough data for now and it is a IPushProducer, the consumer may call its pauseProducing method.

def registerProducer(self, producer, streaming): (source)

Register to receive data from a producer.

This sets self to be a consumer for a producer. When this object runs out of data (as when a send(2) call on a socket succeeds in moving the last data from a userspace buffer into a kernelspace buffer), it will ask the producer to resumeProducing().

For IPullProducer providers, resumeProducing will be called once each time data is required.

For IPushProducer providers, pauseProducing will be called whenever the write buffer fills up and resumeProducing will only be called when it empties. The consumer will only call resumeProducing to balance a previous pauseProducing call; the producer is assumed to start in an un-paused state.

ParametersproducerUndocumented
streamingTrue if producer provides IPushProducer, False if producer provides IPullProducer.
RaisesRuntimeErrorIf a producer is already registered.
def unregisterProducer(self): (source)

Stop consuming data from a producer, without disconnecting.

def _writeSomeData(self, data): (source)

Write as much of this data as possible.

ReturnsThe number of bytes written.
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.