twisted.internet.protocol.ProtocolToConsumerAdapter : API documentation

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:

Class Variable	temporaryAdapter	If this is True, the adapter will not be persisted on the Componentized.
Class Variable	multiComponent	If this adapter is persistent, should it be automatically registered for all appropriate interfaces.
Method	__init__	Set my 'original' attribute to be the object I am adapting.
Instance Variable	original	Undocumented
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)

from twisted.internet.interfaces.IConsumer

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.

Parameters data Undocumented (type: bytes)

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

from twisted.internet.interfaces.IConsumer

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.

Parameters	producer	Undocumented
	streaming	`True` if `producer` provides `IPushProducer`, `False` if `producer` provides `IPullProducer`.
Raises	RuntimeError	If a producer is already registered.

def unregisterProducer(self): (source)

from twisted.internet.interfaces.IConsumer

Stop consuming data from a producer, without disconnecting.