class documentation

class XmlStreamFactory(XmlStreamFactoryMixin, protocol.ReconnectingClientFactory): (source)

Known subclasses: twisted.words.protocols.jabber.xmlstream.XmlStreamFactory

View In Hierarchy

Factory for XmlStream protocol objects as a reconnection client.
Method build​Protocol Create a protocol instance.

Inherited from XmlStreamFactoryMixin:

Method __init__ Undocumented
Instance Variable args Positional arguments passed to the protocol upon instantiation.
Instance Variable kwargs Keyword arguments passed to the protocol upon instantiation.

Inherited from BootstrapMixin (via XmlStreamFactoryMixin):

Method add​Bootstrap Add a bootstrap event handler.
Method install​Bootstraps Install registered bootstrap observers.
Method remove​Bootstrap Remove a bootstrap event handler.
Instance Variable bootstraps The list of registered bootstrap event observers.

Inherited from ReconnectingClientFactory:

Method __getstate__ No summary
Method client​Connection​Failed Called when a connection has failed to connect.
Method client​Connection​Lost Called when an established connection is lost.
Method reset​Delay 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 stop​Trying 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 continue​Trying Undocumented
Instance Variable delay Undocumented
Instance Variable factor A multiplicitive factor by which the delay grows
Instance Variable initial​Delay Delay for the first reconnection attempt.
Instance Variable jitter Percentage of randomness to introduce into the delay length to prevent stampeding.
Instance Variable max​Delay Maximum number of seconds between connection attempts.
Instance Variable max​Retries 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 _call​ID Undocumented

Inherited from ClientFactory (via ReconnectingClientFactory):

Method started​Connecting Called when a connection has been started.

Inherited from Factory (via ReconnectingClientFactory, ClientFactory):

Class Method for​Protocol Create a factory for the given protocol.
Method do​Start Make sure startFactory is called.
Method do​Stop Make sure stopFactory is called.
Method log​Prefix Describe this factory for log messages.
Method start​Factory This will be called before I begin listening on a Port or Connector.
Method stop​Factory This will be called before I stop listening on all Ports/Connectors.
Class Variable noisy Undocumented
Class Variable protocol Undocumented
Instance Variable num​Ports Undocumented
def buildProtocol(self, addr): (source)

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.