t.w.h._NotifyingProducerStream(stream.ProducerStream) : class documentation

Part of twisted.web2.http View Source View In Hierarchy

Undocumented
Method __init__ Undocumented
Method read Read some data.
Method write The producer will write data by calling this method.
Method finish Called by producer when it is done.

Inherited from ProducerStream:

Method split Split this stream into two, at byte position 'point'.
Method close Called by reader of stream when it is done reading.
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
def __init__(self, length=None, doStartReading=None): (source)
overrides twisted.web2.stream.ProducerStream.__init__
Undocumented
def read(self): (source)
from twisted.web2.stream.IByteStream
overrides twisted.web2.stream.ProducerStream.read

Read some data.

Returns an object conforming to the buffer interface, or if there is no more data available, returns None. Can also return a Deferred resulting in one of the above.

Errors may be indicated by exception or by a Deferred of a Failure.
def write(self, data): (source)
from twisted.internet.interfaces.IConsumer
overrides twisted.web2.stream.ProducerStream.write
The producer will write data by calling this method.
def finish(self): (source)
overrides twisted.web2.stream.ProducerStream.finish

Called by producer when it is done.

If the optional failure argument is passed a Failure instance, the stream will return it as errback on next Deferred.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.