class documentation

class twisted.protocols.ftp.SenderProtocol(protocol.Protocol): (source)

Implements interfaces: twisted.protocols.ftp.IFinishableConsumer

View In Hierarchy

Undocumented

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)

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.

Parametersdataa 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)

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)

Called when the connection is shut down.

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

ParametersreasonUndocumented (type: twisted.python.failure.Failure)
def write(self, data): (source)

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)

Register the given producer with our transport.

def unregisterProducer(self): (source)

Unregister the previously registered producer.

def finish(self): (source)

The producer has finished producing.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.