twisted.protocols.ftp.DTPFactory : API documentation

Client factory for data transfer process protocols.

Instance Variables	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`.

Method	__init__	No summary
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.

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):

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.

def __init__(self, pi, peerHost=None, reactor=None): (source)

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

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.

Parameters addr an 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 clientConnectionFailed(self, connector, reason): (source)

Called when a connection has failed to connect.

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

Parameters reason (type: twisted.python.failure.Failure )

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