class documentation

class twisted.web.static.MultipleRangeStaticProducer(StaticProducer): (source)

View In Hierarchy

A StaticProducer that writes several chunks of a file to the request.

Method __init__ Initialize the instance.
Instance Variable rangeInfo Undocumented
Method start Undocumented
Instance Variable rangeIter Undocumented
Instance Variable partBoundary Undocumented
Method resumeProducing Produce data for the consumer a single time.
Method _nextRange Undocumented
Instance Variable _partSize Undocumented
Instance Variable _partBytesWritten Undocumented

Inherited from StaticProducer:

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 stopProducing Stop producing data.
def __init__(self, request, fileObject, rangeInfo): (source)

Initialize the instance.

ParametersrequestSee StaticProducer.
fileObjectSee StaticProducer.
rangeInfoA list of tuples [(boundary, offset, size)] where:
  • boundary will be written to the request first.
  • offset the offset into the file of chunk to write.
  • size the size of the chunk to write.
rangeInfo = (source)

Undocumented

def start(self): (source)
rangeIter = (source)

Undocumented

def _nextRange(self): (source)

Undocumented

partBoundary = (source)

Undocumented

_partSize = (source)

Undocumented

_partBytesWritten = (source)

Undocumented

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

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.