t.p.p.ProducerConsumerProxy(BasicProducerConsumerProxy) : class documentation

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

Known subclasses: twisted.protocols.htb.ShapedConsumer

ProducerConsumerProxy with a finite buffer.

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

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.
Method _writeSomeData Write as much of this data as possible.

Inherited from BasicProducerConsumerProxy:

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 __init__ Undocumented
Method stopProducing Stop producing data.
Method finish Undocumented
Method __repr__ Undocumented
def pauseProducing(self): (source)
Undocumented
def resumeProducing(self): (source)
Undocumented
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.

ParametersstreamingTrue if producer provides IPushProducer, False if producer provides IPullProducer. (type: bool)
ReturnsNone
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 at 2012-09-01 11:44:56.