twisted.protocols.ftp.SenderProtocol : API documentation

Method	__init__	Undocumented
Instance Variable	connectedDeferred	Undocumented
Instance Variable	deferred	Undocumented
Method	dataReceived	Called whenever data is received.
Method	makeConnection	Make a connection to a transport and a server.
Method	connectionLost	Called when the connection is shut down.
Method	write	The producer will write data by calling this method.
Method	registerProducer	Register the given producer with our transport.
Method	unregisterProducer	Unregister the previously registered producer.
Method	finish	The producer has finished producing.

Inherited from Protocol:

Class Variable	factory	Undocumented
Method	logPrefix	Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from BaseProtocol (via Protocol):

Instance Variable	connected	Undocumented
Instance Variable	transport	Undocumented
Method	connectionMade	Called when a connection is made.

def __init__(self): (source)

Undocumented

connectedDeferred = (source)

Undocumented

deferred = (source)

Undocumented

def dataReceived(self, data): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.dataReceived

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.

Parameters data a string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.

def makeConnection(self, transport): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.BaseProtocol.makeConnection

Make a connection to a transport and a server.

This sets the 'transport' attribute of this Protocol, and calls the connectionMade() callback.

def connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

Parameters reason Undocumented (type: twisted.python.failure.Failure)

def write(self, data): (source)

from twisted.internet.interfaces.IConsumer

The producer will write data by calling this method.

The implementation must be non-blocking and perform whatever buffering is necessary. If the producer has provided enough data for now and it is a IPushProducer, the consumer may call its pauseProducing method.

def registerProducer(self, producer, streaming): (source)

from twisted.internet.interfaces.IConsumer

def unregisterProducer(self): (source)

from twisted.internet.interfaces.IConsumer

Unregister the previously registered producer.

def finish(self): (source)

from twisted.protocols.ftp.IFinishableConsumer

The producer has finished producing.