class documentation

class WrappingFactory(ClientFactory): (source)

Known subclasses: twisted.protocols.haproxy._wrapper.HAProxyWrappingFactory, twisted.protocols.policies.LimitConnectionsByPeer, twisted.protocols.policies.SpewingFactory, twisted.protocols.policies.ThrottlingFactory, twisted.protocols.policies.TimeoutFactory, twisted.protocols.policies.TrafficLoggingFactory, twisted.protocols.tls.TLSMemoryBIOFactory

View In Hierarchy

Wraps a factory and its protocols, and keeps track of them.
Method __init__ Undocumented
Method build​Protocol Create an instance of a subclass of Protocol.
Method client​Connection​Failed Called when a connection has failed to connect.
Method client​Connection​Lost Called when an established connection is lost.
Method do​Start Make sure startFactory is called.
Method do​Stop Make sure stopFactory is called.
Method log​Prefix Generate a log prefix mentioning both the wrapped factory and this one.
Method register​Protocol Called by protocol to register itself.
Method started​Connecting Called when a connection has been started.
Method unregister​Protocol Called by protocols when they go away.
Instance Variable protocols Undocumented
Instance Variable wrapped​Factory Undocumented

Inherited from Factory (via ClientFactory):

Class Method for​Protocol Create a factory for the given protocol.
Method start​Factory This will be called before I begin listening on a Port or Connector.
Method stop​Factory This will be called before I stop listening on all Ports/Connectors.
Class Variable noisy Undocumented
Class Variable protocol Undocumented
Instance Variable num​Ports Undocumented
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.

Alternatively, None may be returned to immediately close the new connection.

Override this method to alter how Protocol instances get created.

Parameters
addran object implementing IAddress
def clientConnectionFailed(self, connector, reason): (source)

Called when a connection has failed to connect.

It may be useful to call connector.connect() - this will reconnect.

Parameters
connectorUndocumented
reason:twisted.python.failure.FailureUndocumented
def clientConnectionLost(self, connector, reason): (source)

Called when an established connection is lost.

It may be useful to call connector.connect() - this will reconnect.

Parameters
connectorUndocumented
reason:twisted.python.failure.FailureUndocumented
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 registerProtocol(self, p): (source)
Called by protocol to register itself.
def startedConnecting(self, connector): (source)

Called when a connection has been started.

You can call connector.stopConnecting() to stop the connection attempt.

Parameters
connectora Connector object.
def unregisterProtocol(self, p): (source)
protocols: dict = (source)

Undocumented

wrappedFactory = (source)

Undocumented