twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer : API documentation

feature = (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.

(type: tuple of (str, str))

required = (source)

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

(type: bool)

def __init__(self, xs, required=False): (source)

overridden in twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer

Undocumented

xmlstream = (source)

from twisted.words.protocols.jabber.ijabber.IInitiatingInitializer

The associated XML stream

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)

Start the actual initialization.

May return a deferred for asynchronous 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.
Method	__init__	Undocumented
Instance Variable	xmlstream	The associated XML stream
Method	initialize	Initiate the initialization.
Method	start	Start the actual initialization.