Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`internet`.`protocol`.`ReconnectingClientFactory``

class documentation

`class ReconnectingClientFactory(ClientFactory): (source)`

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

View In Hierarchy

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

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

Method | `__getstate__` | 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.
Method | `clientConnectionFailed` | Called when a connection has failed to connect.
Method | `clientConnectionLost` | Called when an established connection is lost.
Method | `resetDelay` | Call this method after a successful connection: it resets the delay and the retry counter.
Method | `retry` | Have this connector connect again, after a suitable delay.
Method | `stopTrying` | Put a stop to any attempt to reconnect in progress.
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.
Instance Variable | `connector` | Undocumented
Instance Variable | `continueTrying` | Undocumented
Instance Variable | `delay` | Undocumented
Instance Variable | `factor` | A multiplicitive factor by which the delay grows
Instance Variable | `initialDelay` | Delay for the first reconnection attempt.
Instance Variable | `jitter` | Percentage of randomness to introduce into the delay length to prevent stampeding.
Instance Variable | `maxDelay` | Maximum number of seconds between connection attempts.
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.
Instance Variable | `retries` | Undocumented
Instance Variable | `_callID` | Undocumented

Inherited from `ClientFactory`:

Method | `startedConnecting` | Called when a connection has been started.

Inherited from `Factory` (via `ClientFactory`):

Class Method | `forProtocol` | Create a factory for the given protocol.
Method | `buildProtocol` | Create an instance of a subclass of Protocol.
Method | `doStart` | Make sure startFactory is called.
Method | `doStop` | Make sure stopFactory is called.
Method | `logPrefix` | Describe this factory for log messages.
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.
Class Variable | `noisy` | Undocumented
Class Variable | `protocol` | Undocumented
Instance Variable | `numPorts` | Undocumented

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.

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.

Parameters
connector | Undocumented
reason:`twisted.python.failure.Failure` | Undocumented

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.

Parameters
connector | Undocumented
unused_reason | Undocumented
reason:`twisted.python.failure.Failure` | Undocumented

def resetDelay(self): (source)

Call this method after a successful connection: it resets the delay and the retry counter.

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.

clock: `IReactorTime` = (source)

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.

connector = (source)

Undocumented

continueTrying: `int` = (source)

Undocumented

delay = (source)

Undocumented

factor: `float` = (source)

A multiplicitive factor by which the delay grows

initialDelay: `float` = (source)

Delay for the first reconnection attempt.

jitter: `float` = (source)

Percentage of randomness to introduce into the delay length to prevent stampeding.

maxDelay: `int` = (source)

Maximum number of seconds between connection attempts.

maxRetries = (source)

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.

retries: `int` = (source)

Undocumented

_callID = (source)

Undocumented