twisted.protocols.ftp.FileConsumer : API documentation

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

A consumer for FTP input that writes data to a file.

Instance Variables fObj a 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)

from twisted.internet.interfaces.IConsumer

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.

Parameters	producer	(type: `IProducer` provider )
	streaming	`True` if `producer` provides `IPushProducer`, `False` if `producer` provides `IPullProducer`. (type: `bool` )
Returns	`None`
Raises	RuntimeError	If a producer is already registered.

def unregisterProducer(self): (source)

from twisted.internet.interfaces.IConsumer

Stop consuming data from a producer, without disconnecting.

def write(self, bytes): (source)

from twisted.internet.interfaces.IConsumer

The producer will write data by calling this method.