twisted.protocols.ftp.SenderProtocol

class documentation

class SenderProtocol(protocol.Protocol): (source)

Implements interfaces: twisted.protocols.ftp.IFinishableConsumer

View In Hierarchy

Undocumented

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

Inherited from Protocol:

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

Inherited from BaseProtocol (via Protocol):

Method connectionMade Called when a connection is made.
Instance Variable connected Undocumented
Instance Variable transport Undocumented
def __init__(self): (source)

Undocumented

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:twisted.python.failure.FailureUndocumented
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
dataa 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 finish(self): (source)
from twisted.protocols.ftp.IFinishableConsumer

The producer has finished producing.

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 registerProducer(self, producer, streaming): (source)
from twisted.internet.interfaces.IConsumer

Register the given producer with our transport.

def unregisterProducer(self): (source)
from twisted.internet.interfaces.IConsumer

Unregister the previously registered producer.

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.

connectedDeferred = (source)

Undocumented

deferred = (source)

Undocumented