t.w.p.j.x.BaseFeatureInitiatingInitializer(object) : class documentation

Part of twisted.words.protocols.jabber.xmlstream View Source View In Hierarchy

Known subclasses: twisted.words.protocols.jabber.client.BindInitializer, twisted.words.protocols.jabber.client.SessionInitializer, twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer, twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer

Implements interfaces: twisted.words.protocols.jabber.ijabber.IInitiatingInitializer

Base class for initializers with a stream feature.

This assumes the associated XmlStream represents the initiating entity of the connection.
Instance Variablesrequiredwhether the stream feature is required to be advertized by the receiving entity. (type: bool )
Class Variablesfeaturetuple of (uri, name) of the stream feature root element. (type: tuple of (str, str) )
Method __init__ Undocumented
Method initialize Initiate the initialization.
Method start Start the actual initialization.
def __init__(self, xs): (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.
def start(self): (source)

Start the actual initialization.

May return a deferred for asynchronous initialization.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.