twisted.web.static.SingleRangeStaticProducer : API documentation

class documentation

class SingleRangeStaticProducer(StaticProducer): (source)

A StaticProducer that writes a single chunk of a file to the request.

Method	`__init__`	Initialize the instance.
Instance Variable	`offset`	Undocumented
Instance Variable	`size`	Undocumented
Method	`start`	Undocumented
Instance Variable	`bytesWritten`	Undocumented
Method	`resumeProducing`	Produce data for the consumer a single time.

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, offset, size): (source)

overrides twisted.web.static.StaticProducer.__init__

Initialize the instance.

Parameters	request	See `StaticProducer`.
	fileObject	See `StaticProducer`.
	offset	The offset into the file of the chunk to be written.
	size	The size of the chunk to write.

offset = (source)

Undocumented

size = (source)

Undocumented

def start(self): (source)

overrides twisted.web.static.StaticProducer.start

Undocumented

bytesWritten = (source)

Undocumented

(type: int)

def resumeProducing(self): (source)

from twisted.internet.interfaces.IPullProducer

overrides twisted.web.static.StaticProducer.resumeProducing

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 21.2.0 at 2021-02-28 21:00:42.