t.s.u.FilePager(Pager) : class documentation

Part of twisted.spread.util View Source View In Hierarchy

Implements interfaces: twisted.internet.interfaces.IConsumer

Reads a file in chunks and sends the chunks as they come.
Method __init__ Create a pager with a Reference to a remote collector and an optional callable to invoke upon completion.
Method startProducing Undocumented
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Method write The producer will write data by calling this method.
Method sendNextPage Get the first chunk read and send it to collector.

Inherited from Pager:

Method stillPaging (internal) Method called by Broker.
Method nextPage Override this to return an object to be sent to my collector.
Method stopPaging Call this when you're done paging.
def __init__(self, collector, fd, *args, callback=None, **kw): (source)
Create a pager with a Reference to a remote collector and an optional callable to invoke upon completion.
def startProducing(self, fd): (source)
Undocumented
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 write(self, chunk): (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 sendNextPage(self): (source)
Get the first chunk read and send it to collector.
API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.