t.p.p.WrappingFactory(ClientFactory) : class documentation

Part of twisted.protocols.policies View Source View In Hierarchy

Known subclasses: twisted.manhole._inspectro.LoggingFactory, twisted.protocols.policies.LimitConnectionsByPeer, twisted.protocols.policies.SpewingFactory, twisted.protocols.policies.ThrottlingFactory, twisted.protocols.policies.TimeoutFactory, twisted.protocols.policies.TrafficLoggingFactory, twisted.protocols.tls.TLSMemoryBIOFactory

Wraps a factory and its protocols, and keeps track of them.
Method __init__ Undocumented
Method logPrefix Generate a log prefix mentioning both the wrapped factory and this one.
Method doStart Make sure startFactory is called.
Method doStop Make sure stopFactory is called.
Method startedConnecting Called when a connection has been started.
Method clientConnectionFailed Called when a connection has failed to connect.
Method clientConnectionLost Called when an established connection is lost.
Method buildProtocol Create an instance of a subclass of Protocol.
Method registerProtocol Called by protocol to register itself.
Method unregisterProtocol Called by protocols when they go away.

Inherited from Factory (via ClientFactory):

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.
def __init__(self, wrappedFactory): (source)
Undocumented
def logPrefix(self): (source)
Generate a log prefix mentioning both the wrapped factory and this one.
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 startedConnecting(self, connector): (source)
Called when a connection has been started.

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

Parametersconnectora Connector object.
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.

def clientConnectionLost(self, connector, reason): (source)
Called when an established connection is lost.

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

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
def registerProtocol(self, p): (source)
Called by protocol to register itself.
def unregisterProtocol(self, p): (source)
Called by protocols when they go away.
API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.