twisted.words.xish.xmlstream.XmlStreamFactory(XmlStreamFactoryMixin, protocol.ReconnectingClientFactory)
class documentationtwisted.words.xish.xmlstream
View Source
(View In Hierarchy)
Known subclasses: twisted.words.protocols.jabber.xmlstream.XmlStreamFactory
Factory for XmlStream protocol objects as a reconnection client.
Method | buildProtocol | Create a protocol instance. |
Inherited from XmlStreamFactoryMixin:
Instance Variable | args | Positional arguments passed to the protocol upon instantiation. (type: tuple .) |
Instance Variable | kwargs | Keyword arguments passed to the protocol upon instantiation. (type: dict .) |
Method | __init__ | Undocumented |
Inherited from BootstrapMixin (via XmlStreamFactoryMixin):
Instance Variable | bootstraps | The list of registered bootstrap event observers. |
Method | installBootstraps | Install registered bootstrap observers. |
Method | addBootstrap | Add a bootstrap event handler. |
Method | removeBootstrap | Remove a bootstrap event handler. |
Inherited from ReconnectingClientFactory:
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 ClientFactory (via ReconnectingClientFactory):
Method | startedConnecting | Called when a connection has been started. |
Inherited from Factory (via ReconnectingClientFactory, 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. |
Create a protocol instance.
Overrides XmlStreamFactoryMixin.buildProtocol
to work with a ReconnectingClientFactory
.
As this is called upon having an connection established, we are resetting
the delay for reconnection attempts when the connection is lost again.