Go to the latest version of this document.

# ``twisted`.`protocols`.`ftp`.`FTPFactory``

class documentation

`class FTPFactory(policies.LimitTotalConnectionsFactory): (source)`

Constructor: `FTPFactory(portal, userAnonymous)`

View In Hierarchy

A factory for producing ftp protocol instances

Method | `__init__` | Undocumented
Method | `buildProtocol` | Create an instance of a subclass of Protocol.
Method | `stopFactory` | This will be called before I stop listening on all Ports/Connectors.
Class Variable | `allowAnonymous` | Undocumented
Class Variable | `welcomeMessage` | Undocumented
Instance Variable | `instances` | Undocumented
Instance Variable | `passivePortRange` | value forwarded to `protocol.passivePortRange`.
Instance Variable | `portal` | Undocumented
Instance Variable | `timeOut` | the protocol interpreter's idle timeout time in seconds, default is 600 seconds.
Instance Variable | `userAnonymous` | Undocumented

Inherited from `LimitTotalConnectionsFactory`:

Method | `registerProtocol` | Undocumented
Method | `unregisterProtocol` | Undocumented
Class Variable | `connectionLimit` | maximum number of connections.
Class Variable | `overflowProtocol` | Protocol to use for new connections when connectionLimit is exceeded. If `None` (the default value), excess connections will be closed immediately.
Instance Variable | `connectionCount` | number of current connections.

Inherited from `Factory` (via `LimitTotalConnectionsFactory`, `ServerFactory`):

Class Method | `forProtocol` | Create a factory for the given protocol.
Method | `doStart` | Make sure startFactory is called.
Method | `doStop` | Make sure stopFactory is called.
Method | `logPrefix` | Describe this factory for log messages.
Method | `startFactory` | This will be called before I begin listening on a Port or Connector.
Class Variable | `noisy` | Undocumented
Class Variable | `protocol` | Undocumented
Instance Variable | `numPorts` | Undocumented

def __init__(self, portal=None, userAnonymous='anonymous'): (source)

Undocumented

def buildProtocol(self, addr): (source)
from `twisted.internet.interfaces.IProtocolFactory`
overrides `twisted.protocols.policies.LimitTotalConnectionsFactory.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 `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.

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.

allowAnonymous: `bool` = (source)

Undocumented

welcomeMessage = (source)

Undocumented

instances: `list` = (source)

Undocumented

passivePortRange: `iterator` = (source)

value forwarded to `protocol.passivePortRange`.

portal = (source)

Undocumented

timeOut: `int` = (source)

the protocol interpreter's idle timeout time in seconds, default is 600 seconds.

userAnonymous = (source)

Undocumented