Part of twisted.protocols.ftp View Source View In Hierarchy
Implements interfaces: twisted.protocols.ftp.IFinishableConsumer
| Method | __init__ | 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:
| Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Inherited from BaseProtocol (via Protocol):
| Method | connectionMade | Called when a connection is made. |
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. |
This sets the 'transport' attribute of this Protocol, and calls the connectionMade() callback.
Clear any circular references here, and any external references to this Protocol. The connection has been closed.
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.