class SenderProtocol(protocol.Protocol): (source)
Implements interfaces: twisted.protocols.ftp.IFinishableConsumer
Undocumented
Method | __init__ |
Undocumented |
Method | connection |
Called when the connection is shut down. |
Method | data |
Called whenever data is received. |
Method | finish |
The producer has finished producing. |
Method | make |
Make a connection to a transport and a server. |
Method | register |
Register the given producer with our transport. |
Method | unregister |
Unregister the previously registered producer. |
Method | write |
The producer will write data by calling this method. |
Instance Variable | connected |
Undocumented |
Instance Variable | deferred |
Undocumented |
Inherited from Protocol
:
Method | log |
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 | connection |
Called when a connection is made. |
Instance Variable | connected |
Undocumented |
Instance Variable | transport |
Undocumented |
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.Failure | Undocumented |
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. |
Make a connection to a transport and a server.
This sets the 'transport' attribute of this Protocol, and calls the connectionMade() callback.
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.