twisted.internet.protocol.Factory : API documentation

protocol = (source)

overridden in twisted.mail.protocols.POP3Factory, twisted.mail.protocols.SMTPFactory, twisted.mail.relaymanager.SMTPManagedRelayerFactory, twisted.names.server.DNSServerFactory, twisted.protocols.loopback.LoopbackClientFactory

Undocumented

(type: Optional[Callable[[], Protocol]])

numPorts = (source)

Undocumented

noisy = (source)

overridden in twisted.conch.scripts.tkconch.SSHClientFactory, twisted.internet.protocol._InstanceFactory, twisted.protocols.ftp._PassiveConnectionFactory, twisted.protocols.ftp.FTPDataPortFactory, twisted.words.protocols.irc.DccChatFactory

Undocumented

(type: bool)

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

Parameters	protocol	A `Protocol` subclass
	args	Positional arguments for the factory.
	kwargs	Keyword arguments for the factory.
Returns	A `Factory` instance wired up to `protocol`.

def logPrefix(self): (source)

from twisted.internet.interfaces.ILoggingContext

Describe this factory for log messages.

def doStart(self): (source)

from twisted.internet.interfaces.IProtocolFactory

overridden in twisted.internet.endpoints._WrappingFactory

Make sure startFactory is called.

Users should not call this function themselves!

def doStop(self): (source)

from twisted.internet.interfaces.IProtocolFactory

overridden in twisted.internet.endpoints._WrappingFactory

Make sure stopFactory is called.

Users should not call this function themselves!

def startFactory(self): (source)

overridden in twisted.conch.ssh.factory.SSHFactory, twisted.web.http.HTTPFactory

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)

overridden in twisted.conch.scripts.tkconch.SSHClientFactory, twisted.protocols.ftp.DTPFactory, twisted.web.http.HTTPFactory

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)

from twisted.internet.interfaces.IProtocolFactory

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` (type: `Tuple[str, int]`)
Returns	Undocumented (type: `Protocol`)

Class Variable	protocol	Undocumented
Instance Variable	numPorts	Undocumented
Class Variable	noisy	Undocumented
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.