t.p.p.BasicProducerConsumerProxy : class documentation

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

Known subclasses: twisted.protocols.pcp.ProducerConsumerProxy

Implements interfaces: twisted.internet.interfaces.IConsumer, twisted.internet.interfaces.IProducer

I can act as a man in the middle between any Producer and Consumer.
Instance Variablesproducerthe Producer I subscribe to. (type: IProducer )
consumerthe Consumer I publish to. (type: IConsumer )
pausedAs a Producer, am I paused? (type: bool )
Method __init__ Undocumented
Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Stop producing data.
Method write The producer will write data by calling this method.
Method finish Undocumented
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Method __repr__ Undocumented
def __init__(self, consumer): (source)
def pauseProducing(self): (source)
def resumeProducing(self): (source)
def stopProducing(self): (source)

Stop producing data.

This tells a producer that its consumer has died, so it must stop producing data for good.
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 finish(self): (source)
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.
Parametersproducer (type: IProducer provider )
streamingTrue if producer provides IPushProducer, False if producer provides IPullProducer. (type: bool )
RaisesRuntimeErrorIf a producer is already registered.
def unregisterProducer(self): (source)
Stop consuming data from a producer, without disconnecting.
def __repr__(self): (source)
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:27:37.