t.i.p.ProtocolToConsumerAdapter(components.Adapter) : class documentation

Part of twisted.internet.protocol View Source View In Hierarchy

Implements interfaces: twisted.internet.interfaces.IConsumer

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 Adapter:

Method __init__ Set my 'original' attribute to be the object I am adapting.
Method __conform__ I forward __conform__ to self.original if it has it, otherwise I simply return None.
Method isuper Forward isuper to self.original
def write(self, data): (source)
The producer will write data by calling this 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.
Parametersproducer (type: IProducer provider )
streamingTrue if producer provides IPushProducer, False if producer provides IPullProducer. (type: bool )
ReturnsNone
def unregisterProducer(self): (source)
Stop consuming data from a producer, without disconnecting.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.