t.i.p.ReconnectingClientFactory(ClientFactory) : class documentation

Part of twisted.internet.protocol View Source View In Hierarchy

Known subclasses: twisted.words.xish.xmlstream.XmlStreamFactory

My clients auto-reconnect with an exponential back-off.

Note that clients should call my resetDelay method after they have connected successfully.
Instance VariablesmaxDelayMaximum number of seconds between connection attempts.
initialDelayDelay for the first reconnection attempt.
factora multiplicitive factor by which the delay grows
jitterpercentage of randomness to introduce into the delay length to prevent stampeding.
Method clientConnectionFailed Called when a connection has failed to connect.
Method clientConnectionLost Called when an established connection is lost.
Method retry Have this connector connect again, after a suitable delay.
Method stopTrying I put a stop to any attempt to reconnect in progress.
Method resetDelay Call me after a successful connection to reset.
Method __getstate__ No summary

Inherited from ClientFactory:

Method startedConnecting Called when a connection has been started.

Inherited from Factory (via ClientFactory):

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.
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.
Parametersreason (type: twisted.python.failure.Failure )
def clientConnectionLost(self, connector, unused_reason): (source)

Called when an established connection is lost.

It may be useful to call connector.connect() - this will reconnect.
Parametersreason (type: twisted.python.failure.Failure )
def retry(self, connector=None): (source)
Have this connector connect again, after a suitable delay.
def stopTrying(self): (source)
I put a stop to any attempt to reconnect in progress.
def resetDelay(self): (source)

Call me after a successful connection to reset.

I reset the delay and the retry counter.
def __getstate__(self): (source)
Remove all of the state which is mutated by connection attempts and failures, returning just the state which describes how reconnections should be attempted. This will make the unserialized instance behave just as this one did when it was first instantiated.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.