t.w.s.StaticProducer(object) : class documentation

Part of twisted.web.static View Source View In Hierarchy

Known subclasses: twisted.web.static.MultipleRangeStaticProducer, twisted.web.static.NoRangeStaticProducer, twisted.web.static.SingleRangeStaticProducer

Implements interfaces: twisted.internet.interfaces.IPullProducer

Superclass for classes that implement the business of producing.
Instance VariablesrequestThe IRequest to write the contents of the file to.
fileObjectThe file the contents of which to write to the request.
Method __init__ Initialize the instance.
Method start Undocumented
Method resumeProducing Produce data for the consumer a single time.
Method stopProducing Stop producing data.
def __init__(self, request, fileObject): (source)
Initialize the instance.
def start(self): (source)
def resumeProducing(self): (source)

Produce data for the consumer a single time.

This tells a producer to produce data for the consumer once (not repeatedly, once only). Typically this will be done by calling the consumer's write() method a single time with produced data.
def stopProducing(self): (source)

Stop producing data.

IPullProducer.stopProducing is called when our consumer has died, and subclasses also call this method when they are done producing data.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:12:41.