twisted.internet.protocol.Factory
class documentationtwisted.internet.protocol
View Source
(View In Hierarchy)
Known subclasses: twisted.conch.ssh.factory.SSHFactory, twisted.conch.ssh.forwarding.SSHListenForwardingFactory, twisted.internet.protocol.ClientFactory, twisted.internet.protocol.ServerFactory, twisted.protocols.portforward.ProxyFactory, twisted.protocols.socks.SOCKSv4Factory, twisted.protocols.socks.SOCKSv4IncomingFactory, twisted.web.client._HTTP11ClientFactory, twisted.words.protocols.irc.DccSendFactory
Implements interfaces: twisted.internet.interfaces.ILoggingContext, twisted.internet.interfaces.IProtocolFactory
This is a factory which produces protocols.
By default, buildProtocol will create a protocol of the class given in self.protocol.
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. |
Method | stopFactory | This will be called before I stop listening on all Ports/Connectors. |
Method | buildProtocol | Create an instance of a subclass of Protocol. |
Describe this factory for log messages.
Make sure startFactory is called.
Users should not call this function themselves!
Make sure stopFactory is called.
Users should not call this function themselves!
This will be called before I begin listening on a Port or Connector.
It will only be called once, even if the factory is connected to multiple ports.
This can be used to perform 'unserialization' tasks that are best put off until things are actually running, such as connecting to a database, opening files, etcetera.
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.
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 |