t.p.f.FileConsumer(object) : class documentation

Part of twisted.protocols.ftp View Source View In Hierarchy

Implements interfaces: twisted.internet.interfaces.IConsumer

A consumer for FTP input that writes data to a file.
Instance VariablesfObja file object opened for writing, used to write data received. (type: file )
Method __init__ Undocumented
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Method write The producer will write data by calling this method.
def __init__(self, fObj): (source)
Undocumented
def registerProducer(self, producer, streaming): (source)

Register to receive data from a producer.

This sets self to be a consumer for a producer. When this object runs out of data (as when a send(2) call on a socket succeeds in moving the last data from a userspace buffer into a kernelspace buffer), it will ask the producer to resumeProducing().

For IPullProducer providers, resumeProducing will be called once each time data is required.

For IPushProducer providers, pauseProducing will be called whenever the write buffer fills up and resumeProducing will only be called when it empties.
Parametersproducer (type: IProducer provider )
streamingTrue if producer provides IPushProducer, False if producer provides IPullProducer. (type: bool )
ReturnsNone
RaisesRuntimeErrorIf a producer is already registered.
def unregisterProducer(self): (source)
Stop consuming data from a producer, without disconnecting.
def write(self, bytes): (source)
The producer will write data by calling this method.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.