Class t.p.f.FTPClientBasic(basic.LineReceiver):

Part of twisted.protocols.ftp View Source View In Hierarchy

Known subclasses: twisted.protocols.ftp.FTPClient

Foundations of an FTP client.

Split Table into Classes Show Methods in One Table

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

Inherited from LineReceiver:

Line # Kind Name Docs
207 Method clearLineBuffer Clear buffered data.
211 Method dataReceived Protocol.dataReceived.
241 Method setLineMode Sets the line-mode of this receiver.
256 Method setRawMode Sets the raw mode of this receiver.
263 Method rawDataReceived Override this for when raw data is received.
278 Method lineLengthExceeded Called when the maximum line length has been reached.

Inherited from BaseProtocol (via LineReceiver, Protocol):

Line # Kind Name Docs
341 Method makeConnection Make a connection to a transport and a server.
351 Method connectionMade Called when a connection is made.

Inherited from _PauseableMixin (via LineReceiver):

Line # Kind Name Docs
172 Method pauseProducing Undocumented
176 Method resumeProducing Undocumented
181 Method stopProducing Undocumented
Line # Kind Name Docs
1972 Method __init__ Undocumented
207 Method clearLineBuffer Clear buffered data.
2157 Method connectionLost Called when the connection is shut down.
351 Method connectionMade Called when a connection is made.
211 Method dataReceived Protocol.dataReceived.
1980 Method fail Give an error to any queued deferreds.
278 Method lineLengthExceeded Called when the maximum line length has been reached.
2112 Method lineReceived (Private) Parses the response messages from the FTP server.
341 Method makeConnection Make a connection to a transport and a server.
172 Method pauseProducing Undocumented
2068 Method popCommandQueue Return the front element of the command queue, or None if empty.
2038 Method queueCommand Add an FTPCommand object to the queue.
2077 Method queueLogin Login: send the username, send the password.
2053 Method queueStringCommand Queues a string to be issued as an FTP command
263 Method rawDataReceived Override this for when raw data is received.
176 Method resumeProducing Undocumented
2006 Method sendLine (Private) Sends a line, unless line is None.
2014 Method sendNextCommand (Private) Processes the next command in the queue.
241 Method setLineMode Sets the line-mode of this receiver.
256 Method setRawMode Sets the raw mode of this receiver.
181 Method stopProducing Undocumented
2003 Method _cb_greeting Undocumented
1986 Method _fail Errback all queued deferreds.
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.
ParametersftpCommandan FTPCommand
def queueStringCommand(self, command, public=1): (source)
Queues a string to be issued as an FTP command
Parameterscommandstring of an FTP command to queue
publica flag intended for internal use by FTPClient. Don't change it unless you know what you're doing.
Returnsa 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

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.
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.
Parametersreason (type: twisted.python.failure.Failure )
API Documentation for Twisted, generated by pydoctor at 2008-10-26 16:12:37.