twisted.protocols.ftp.DTPFactory(protocol.ClientFactory)
class documentationtwisted.protocols.ftp
View Source
(View In Hierarchy)
Client factory for data transfer process protocols.
Instance Variable | peerCheck | perform checks to make sure the ftp-pi's peer is the same as the dtp's |
Instance Variable | pi | a reference to this factory's protocol interpreter |
Method | __init__ | Constructor |
Method | buildProtocol | Create an instance of a subclass of Protocol. |
Method | stopFactory | This will be called before I stop listening on all Ports/Connectors. |
Method | timeoutFactory | Undocumented |
Method | cancelTimeout | Undocumented |
Method | setTimeout | Undocumented |
Method | clientConnectionFailed | Called when a connection has failed to connect. |
Instance Variable | _state | Indicates the current state of the DTPFactory. Initially, this is _IN_PROGRESS .
If the connection fails or times out, it is _FAILED .
If the connection succeeds before the timeout, it is _FINISHED . |
Class Variable | _IN_PROGRESS | Token to signal that connection is active. (type: object .) |
Class Variable | _FAILED | Token to signal that connection has failed. (type: object .) |
Class Variable | _FINISHED | Token to signal that connection was successfully closed. (type: object .) |
Inherited from ClientFactory:
Method | startedConnecting | Called when a connection has been started. |
Method | clientConnectionLost | Called when an established connection is lost. |
Inherited from Factory (via ClientFactory):
Class Method | forProtocol | Create a factory for the given protocol. |
Method | logPrefix | Describe this factory for log messages. |
Method | doStart | Make sure startFactory is called. |
Method | doStop | Make sure stopFactory is called. |
Method | startFactory | This will be called before I begin listening on a Port or Connector. |
_IN_PROGRESS
.
If the connection fails or times out, it is _FAILED
.
If the connection succeeds before the timeout, it is _FINISHED
.
Constructor
Parameters | pi | this factory's protocol interpreter |
peerHost | if peerCheck is True, this is the tuple that the generated instance will use to perform security checks |
Create an instance of a subclass of Protocol.
The returned instance will handle input on an incoming server connection, and an attribute "factory" pointing to the creating factory.
Alternatively, None
may be returned to immediately close the new connection.
Override this method to alter how Protocol instances get created.
Parameters | addr | an object implementing twisted.internet.interfaces.IAddress |
This will be called before I stop listening on all Ports/Connectors.
This can be overridden to perform 'shutdown' tasks such as disconnecting database connections, closing files, etc.
It will be called, for example, before an application shuts down, if it was connected to a port. User code should not call this function directly.
Called when a connection has failed to connect.
It may be useful to call connector.connect() - this will reconnect.