twisted.words.xish.xmlstream.BootstrapMixin

class documentation

class BootstrapMixin: (source)

Known subclasses: twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory, twisted.words.xish.xmlstream.XmlStreamFactoryMixin

View In Hierarchy

XmlStream factory mixin to install bootstrap event observers.

This mixin is for factories providing IProtocolFactory to make sure bootstrap event observers are set up on protocols, before incoming data is processed. Such protocols typically derive from utility.EventDispatcher, like XmlStream.

You can set up bootstrap event observers using addBootstrap. The event and fn parameters correspond with the event and observerfn arguments to utility.EventDispatcher.addObserver.

Present Since
8.2.
Method __init__ Undocumented
Method addBootstrap Add a bootstrap event handler.
Method installBootstraps Install registered bootstrap observers.
Method removeBootstrap Remove a bootstrap event handler.
Instance Variable bootstraps The list of registered bootstrap event observers.
def __init__(self): (source)
overridden in twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory, twisted.words.xish.xmlstream.XmlStreamFactoryMixin

Undocumented

def addBootstrap(self, event, fn): (source)

Add a bootstrap event handler.

Parameters
event:str or xpath.XPathQueryThe event to register an observer for.
fnThe observer callable to be registered.
def installBootstraps(self, dispatcher): (source)

Install registered bootstrap observers.

Parameters
dispatcher:utility.EventDispatcherEvent dispatcher to add the observers to.
def removeBootstrap(self, event, fn): (source)

Remove a bootstrap event handler.

Parameters
event:str or xpath.XPathQueryThe event the observer is registered for.
fnThe registered observer callable.
bootstraps: list = (source)

The list of registered bootstrap event observers.