class documentation

Base class for initializers with a stream feature.

This assumes the associated XmlStream represents the initiating entity of the connection.

Method __init__ Undocumented
Method initialize Initiate the initialization.
Method start Start the actual initialization.
Class Variable feature tuple of (uri, name) of the stream feature root element.
Instance Variable required whether the stream feature is required to be advertized by the receiving entity.
Instance Variable xmlstream The associated XML stream
def __init__(self, xs, required=False): (source)
def initialize(self): (source)

Initiate the initialization.

Checks if the receiving entity advertizes the stream feature. If it does, the initialization is started. If it is not advertized, and the required instance variable is True, it raises FeatureNotAdvertized. Otherwise, the initialization silently succeeds.

required: bool = (source)

whether the stream feature is required to be advertized by the receiving entity.