twisted.words.xish.xmlstream.BootstrapMixin(object) class documentation

Part of twisted.words.xish.xmlstream View Source (View In Hierarchy)

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

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 Since8.2.
Instance Variable bootstraps The list of registered bootstrap event observers.
Method __init__ Undocumented
Method installBootstraps Install registered bootstrap observers.
Method addBootstrap Add a bootstrap event handler.
Method removeBootstrap Remove a bootstrap event handler.
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 installBootstraps(self, dispatcher): (source)

Install registered bootstrap observers.

ParametersdispatcherEvent dispatcher to add the observers to. (type: utility.EventDispatcher)
def addBootstrap(self, event, fn): (source)

Add a bootstrap event handler.

ParameterseventThe event to register an observer for. (type: str or xpath.XPathQuery)
fnThe observer callable to be registered.
def removeBootstrap(self, event, fn): (source)

Remove a bootstrap event handler.

ParameterseventThe event the observer is registered for. (type: str or xpath.XPathQuery)
fnThe registered observer callable.
API Documentation for Twisted, generated by pydoctor at 2018-07-14 04:53:34.