twisted.protocols.ftp.FTPClientBasic : API documentation

Method	__init__	Undocumented
Method	fail	Give an error to any queued deferreds.
Method	sendLine	(Private) Sends a line, unless line is None.
Method	sendNextCommand	(Private) Processes the next command in the queue.
Method	queueCommand	Add an FTPCommand object to the queue.
Method	queueStringCommand	Queues a string to be issued as an FTP command
Method	popCommandQueue	Return the front element of the command queue, or None if empty.
Method	queueLogin	Login: send the username, send the password.
Method	lineReceived	(Private) Parses the response messages from the FTP server.
Method	connectionLost	Called when the connection is shut down.
Method	_fail	Errback all queued deferreds.
Method	_cb_greeting	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

def __init__(self): (source)

overridden in twisted.protocols.ftp.FTPClient

Undocumented

def fail(self, error): (source)

overridden in twisted.protocols.ftp.FTPClient

Give an error to any queued deferreds.

def _fail(self, error): (source)

Errback all queued deferreds.

def _cb_greeting(self, greeting): (source)

Undocumented

def sendLine(self, line): (source)

overrides twisted.protocols.basic.LineReceiver.sendLine

(Private) Sends a line, unless line is None.

def sendNextCommand(self): (source)

(Private) Processes the next command in the queue.

def queueCommand(self, ftpCommand): (source)

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 ftpCommand an FTPCommand

def queueStringCommand(self, command, public=1): (source)

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.

def popCommandQueue(self): (source)

Return the front element of the command queue, or None if empty.

def queueLogin(self, username, password): (source)

overridden in twisted.protocols.ftp.FTPClient

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.

def lineReceived(self, line): (source)

overrides twisted.protocols.basic.LineReceiver.lineReceived

(Private) Parses the response messages from the FTP server.

def connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

twisted.protocols.ftp.FTPClientBasic(basic.LineReceiver) class documentation

`twisted.protocols.ftp.FTPClientBasic(basic.LineReceiver)` class documentation