twisted.web.static.StaticProducer : API documentation

Instance Variable	request	The `IRequest` to write the contents of the file to.
Instance Variable	fileObject	The 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.

request = (source)

The IRequest to write the contents of the file to.

fileObject = (source)

The file the contents of which to write to the request.

def __init__(self, request, fileObject): (source)

overridden in twisted.web.static.MultipleRangeStaticProducer, twisted.web.static.SingleRangeStaticProducer

Initialize the instance.

def start(self): (source)

overridden in twisted.web.static.MultipleRangeStaticProducer, twisted.web.static.NoRangeStaticProducer, twisted.web.static.SingleRangeStaticProducer

Undocumented

def resumeProducing(self): (source)

from twisted.internet.interfaces.IPullProducer

overridden in twisted.web.static.MultipleRangeStaticProducer, twisted.web.static.NoRangeStaticProducer, twisted.web.static.SingleRangeStaticProducer

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. The producer should produce data before returning from resumeProducing(), that is, it should not schedule a deferred write.

def stopProducing(self): (source)

from twisted.internet.interfaces.IProducer

Stop producing data.

twisted.internet.interfaces.IProducer.stopProducing is called when our consumer has died, and subclasses also call this method when they are done producing data.