twisted.internet.protocol.ReconnectingClientFactory(ClientFactory) class documentation

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

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

Factory which auto-reconnects clients with an exponential back-off.

Note that clients should call my resetDelay method after they have connected successfully.

Instance Variable maxDelay Maximum number of seconds between connection attempts.
Instance Variable initialDelay Delay for the first reconnection attempt.
Instance Variable factor A multiplicitive factor by which the delay grows
Instance Variable jitter Percentage of randomness to introduce into the delay length to prevent stampeding.
Instance Variable clock The clock used to schedule reconnection. It's mainly useful to be parametrized in tests. If the factory is serialized, this attribute will not be serialized, and the default value (the reactor) will be restored when deserialized. (type: IReactorTime)
Instance Variable maxRetries Maximum number of consecutive unsuccessful connection attempts, after which no further connection attempts will be made. If this is not explicitly set, no maximum is applied.
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 Put a stop to any attempt to reconnect in progress.
Method resetDelay Call this method after a successful connection: it resets the delay and the retry counter.
Method __getstate__ No summary

Inherited from Factory (via ClientFactory):

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.

Inherited from Factory (via ClientFactory):

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.
maxDelay =
Maximum number of seconds between connection attempts.
initialDelay =
Delay for the first reconnection attempt.
factor =
A multiplicitive factor by which the delay grows
jitter =
Percentage of randomness to introduce into the delay length to prevent stampeding.
clock =
The clock used to schedule reconnection. It's mainly useful to be parametrized in tests. If the factory is serialized, this attribute will not be serialized, and the default value (the reactor) will be restored when deserialized. (type: IReactorTime)
maxRetries =
Maximum number of consecutive unsuccessful connection attempts, after which no further connection attempts will be made. If this is not explicitly set, no maximum is applied.
def clientConnectionFailed(self, connector, reason): (source)
overrides twisted.internet.protocol.ClientFactory.clientConnectionFailed

Called when a connection has failed to connect.

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

def clientConnectionLost(self, connector, unused_reason): (source)
overrides twisted.internet.protocol.ClientFactory.clientConnectionLost

Called when an established connection is lost.

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

def retry(self, connector=None): (source)

Have this connector connect again, after a suitable delay.

def stopTrying(self): (source)

Put a stop to any attempt to reconnect in progress.

def resetDelay(self): (source)

Call this method after a successful connection: it resets 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 2016-04-11 10:39:53.