Part of twisted.protocols.ftp View Source View In Hierarchy
Implements interfaces: twisted.internet.interfaces.IConsumer
|Method||connectionMade||Called when a connection is made.|
|Method||connectionLost||Called when the connection is shut down.|
|Method||sendLine||Send a line to data channel.|
|Method||registerProducer||Register to receive data from a producer.|
|Method||unregisterProducer||Stop consuming data from a producer, without disconnecting.|
|Method||write||The producer will write data by calling this method.|
|Method||dataReceived||Called whenever data is received.|
Inherited from Protocol:
|Method||logPrefix||Return a prefix matching the class name, to identify log messages related to this protocol instance.|
|Method||makeConnection||Make a connection to a transport and a server.|
This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
Clear any circular references here, and any external references to this Protocol. The connection has been closed.
|Parameters||line||The line to be sent. (type: |
This sets self to be a consumer for a producer. When this object runs out of data (as when a send(2) call on a socket succeeds in moving the last data from a userspace buffer into a kernelspace buffer), it will ask the producer to resumeProducing().
resumeProducing will be called once each time data
pauseProducing will be called whenever the write
buffer fills up and
resumeProducing will only be called when
|Raises||RuntimeError||If a producer is already registered.|
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
the consumer may call its
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.|