twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer

class documentation

class BaseFeatureInitiatingInitializer: (source)

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

Constructor: BaseFeatureInitiatingInitializer(xs, required)

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

View In Hierarchy

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)
overridden in twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer

Undocumented

def initialize(self): (source)
from twisted.words.protocols.jabber.ijabber.IInitiatingInitializer

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)
overridden in twisted.words.protocols.jabber.client.BindInitializer, twisted.words.protocols.jabber.client.SessionInitializer, twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer, twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer

Start the actual initialization.

May return a deferred for asynchronous initialization.

feature: tuple of (str, str) = (source)
overridden in twisted.words.protocols.jabber.client.BindInitializer, twisted.words.protocols.jabber.client.SessionInitializer, twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer, twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer

tuple of (uri, name) of the stream feature root element.

required: bool = (source)

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

xmlstream = (source)
from twisted.words.protocols.jabber.ijabber.IInitiatingInitializer

The associated XML stream