Class t.p.f.SenderProtocol(protocol.Protocol):

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

Implements interfaces: twisted.internet.interfaces.IFinishableConsumer

No class docstring

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
1883 Method __init__ Undocumented
1891 Method dataReceived Called whenever data is received.
1897 Method makeConnection Make a connection to a transport and a server.
1901 Method connectionLost Called when the connection is shut down.
1908 Method write Undocumented
1911 Method registerProducer Register the given producer with our transport.
1917 Method unregisterProducer Unregister the previously registered producer.
1923 Method finish The producer has finished producing.

Inherited from BaseProtocol (via Protocol):

Line # Kind Name Docs
351 Method connectionMade Called when a connection is made.
Line # Kind Name Docs
1883 Method __init__ Undocumented
1901 Method connectionLost Called when the connection is shut down.
351 Method connectionMade Called when a connection is made.
1891 Method dataReceived Called whenever data is received.
1923 Method finish The producer has finished producing.
1897 Method makeConnection Make a connection to a transport and a server.
1911 Method registerProducer Register the given producer with our transport.
1917 Method unregisterProducer Unregister the previously registered producer.
1908 Method write Undocumented
def __init__(self): (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.
Parametersreason (type: twisted.python.failure.Failure )
def write(self, data): (source)
Undocumented
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 at 2008-10-26 16:12:37.