twisted.protocols.ftp.DTPFactory : API documentation

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 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.

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.

_IN_PROGRESS =

Token to signal that connection is active. (type: object.)

_FAILED =

Token to signal that connection has failed. (type: object.)

_FINISHED =

Token to signal that connection was successfully closed. (type: object.)

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)

from twisted.internet.interfaces.IProtocolFactory

overrides twisted.internet.protocol.Factory.buildProtocol

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

def stopFactory(self): (source)

overrides twisted.internet.protocol.Factory.stopFactory

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.