t.i.p.Factory : class documentation

Part of twisted.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.manhole.telnet.ShellFactory, twisted.protocols.portforward.ProxyFactory, twisted.protocols.socks.SOCKSv4Factory, twisted.protocols.socks.SOCKSv4IncomingFactory, twisted.web.client._HTTP11ClientFactory, twisted.words.protocols.irc.DccSendFactory

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.
@classmethod
def forProtocol(cls, protocol, *args, **kwargs): (source)
Create a factory for the given protocol.

It sets the protocol attribute and returns the constructed factory instance.

ParametersprotocolA Protocol subclass
argsPositional arguments for the factory.
kwargsKeyword arguments for the factory.
ReturnsA Factory instance wired up to protocol.
def logPrefix(self): (source)
Describe this factory for log messages.
def doStart(self): (source)
Make sure startFactory is called.

Users should not call this function themselves!

def doStop(self): (source)
Make sure stopFactory is called.

Users should not call this function themselves!

def startFactory(self): (source)
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.

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 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
API Documentation for Twisted, generated by pydoctor at 2013-11-18 18:11:01.