class FTPClientBasic(basic.LineReceiver): (source)
Known subclasses: twisted.protocols.ftp.FTPClient
Foundations of an FTP client.
Method | __init__ |
Undocumented |
Method | connection |
Called when the connection is shut down. |
Method | fail |
Give an error to any queued deferreds. |
Method | line |
(Private) Parses the response messages from the FTP server. |
Method | pop |
Return the front element of the command queue, or None if empty. |
Method | queue |
Add an FTPCommand object to the queue. |
Method | queue |
Login: send the username, send the password. |
Method | queue |
Queues a string to be issued as an FTP command |
Method | send |
Sends a line, unless line is None. |
Method | send |
(Private) Processes the next command in the queue. |
Class Variable | debug |
Undocumented |
Instance Variable | action |
Undocumented |
Instance Variable | greeting |
Undocumented |
Instance Variable | next |
Undocumented |
Instance Variable | response |
Undocumented |
Method | _cb |
Undocumented |
Method | _fail |
Errback all queued deferreds. |
Class Variable | _encoding |
Undocumented |
Instance Variable | _failed |
Undocumented |
Inherited from LineReceiver
:
Method | clear |
Clear buffered data. |
Method | data |
Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.) |
Method | line |
Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way. |
Method | raw |
Override this for when raw data is received. |
Method | set |
Sets the line-mode of this receiver. |
Method | set |
Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived. |
Constant | MAX |
The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384. |
Class Variable | delimiter |
The line-ending delimiter to use. By default this is b'\r\n'. |
Instance Variable | line |
Undocumented |
Instance Variable | _buffer |
Undocumented |
Instance Variable | _busy |
Undocumented |
Inherited from Protocol
(via LineReceiver
):
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 LineReceiver
, Protocol
):
Method | connection |
Called when a connection is made. |
Method | make |
Make a connection to a transport and a server. |
Instance Variable | connected |
Undocumented |
Instance Variable | transport |
Undocumented |
Inherited from _PauseableMixin
(via LineReceiver
, Protocol
, BaseProtocol
):
Method | pause |
Undocumented |
Method | resume |
Undocumented |
Method | stop |
Undocumented |
Instance Variable | paused |
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 |
Add an FTPCommand object to the queue.
If it's the only thing in the queue, and we are connected and we aren't waiting for a response of an earlier command, the command will be sent immediately.
Parameters | |
ftp | an FTPCommand |
twisted.protocols.ftp.FTPClient
Login: send the username, send the password.
If the password is None
, the PASS command won't be sent. Also, if the response to the USER command has a response code of 230 (User logged in), then PASS won't be sent either.
Queues a string to be issued as an FTP command
Parameters | |
command | string of an FTP command to queue |
public | a flag intended for internal use by FTPClient. Don't change it unless you know what you're doing. |
Returns | |
a Deferred that will be called when the response to the command has been received. |