twisted.protocols.basic.FileSender

class documentation

class FileSender: (source)

Implements interfaces: twisted.internet.interfaces.IProducer

View In Hierarchy

A producer that sends the contents of a file to a consumer.

This is a helper for protocols that, at some point, will take a file-like object, read its contents, and write them out to the network, optionally performing some transformation on the bytes in between.

Method begin​File​Transfer Begin transferring a file
Method pause​Producing Undocumented
Method resume​Producing Undocumented
Method stop​Producing Stop producing data.
Constant CHUNK​_SIZE Undocumented
Instance Variable consumer Undocumented
Instance Variable deferred Undocumented
Instance Variable file Undocumented
Instance Variable last​Sent Undocumented
Instance Variable transform Undocumented
def beginFileTransfer(self, file, consumer, transform=None): (source)
Begin transferring a file
Parameters
file:Any file-like objectThe file object to read data from
consumer:Any implementor of IConsumerThe object to write data to
transformA callable taking one string argument and returning the same. All bytes read from the file are passed through this before being written to the consumer.
Returns
DeferredA deferred whose callback will be invoked when the file has been completely written to the consumer. The last byte written to the consumer is passed to the callback.
def pauseProducing(self): (source)

Undocumented

def resumeProducing(self): (source)

Undocumented

def stopProducing(self): (source)
from twisted.internet.interfaces.IProducer

Stop producing data.

This tells a producer that its consumer has died, so it must stop producing data for good.

CHUNK_SIZE = (source)

Undocumented

Value
2**14
consumer = (source)

Undocumented

deferred = (source)

Undocumented

file = (source)

Undocumented

lastSent = (source)

Undocumented

transform = (source)

Undocumented