t.w.p.j.i.IService(Interface) : interface documentation

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

Known implementations: twisted.words.protocols.jabber.component.Service

External server-side component service interface.

Services that provide this interface can be added to ServiceManager to implement (part of) the functionality of the server-side component.

Method componentConnected Parent component has established a connection.
Method componentDisconnected Parent component has lost the connection to the Jabber server.
Method transportConnected Parent component has established a connection over the underlying transport.
def componentConnected(xs): (source)
Parent component has established a connection.

At this point, authentication was succesful, and XML stanzas can be exchanged over the XML stream xs. This method can be used to setup observers for incoming stanzas.

ParametersxsXML Stream that represents the established connection. (type: xmlstream.XmlStream)
def componentDisconnected(): (source)
Parent component has lost the connection to the Jabber server.

Subsequent use of self.parent.send will result in data being queued until a new connection has been established.

def transportConnected(xs): (source)
Parent component has established a connection over the underlying transport.

At this point, no traffic has been exchanged over the XML stream. This method can be used to change properties of the XML Stream (in xs), the service manager or it's authenticator prior to stream initialization (including authentication).

API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.