t.p.f.DTPFactory(protocol.ClientFactory) : class documentation

Part of twisted.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.

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.
peerCheck =
perform checks to make sure the ftp-pi's peer is the same as the dtp's
pi =
a reference to this factory's protocol interpreter
_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.
def __init__(self, pi, peerHost=None, reactor=None): (source)
Constructor
Parameterspithis factory's protocol interpreter
peerHostif peerCheck is True, this is the tuple that the generated instance will use to perform security checks
def buildProtocol(self, addr): (source)
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.

Override this method to alter how Protocol instances get created.

Parametersaddran object implementing twisted.internet.interfaces.IAddress
def stopFactory(self): (source)
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.

def timeoutFactory(self): (source)
Undocumented
def cancelTimeout(self): (source)
Undocumented
def setTimeout(self, seconds): (source)
Undocumented
def clientConnectionFailed(self, connector, reason): (source)
Called when a connection has failed to connect.

It may be useful to call connector.connect() - this will reconnect.

API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.