Class Dispatcher

Overrides: client.PlugIn.__init__

Return set of user-registered callbacks in it's internal format. Used within the library to carry user handlers set over Dispatcher replugins.

Restores user-registered callbacks structure from dump previously obtained via dumpHandlers. Used within the library to carry user handlers set over Dispatcher replugins.

Plug the Dispatcher instance into Client class instance and send initial stream header. Used internally.

Check incoming stream for data waiting. If "timeout" is positive - block for as max. this time. Returns: 1) length of processed data if some data were processed; 2) '0' string if no data were processed but link is alive; 3) 0 (zero) if underlying connection is closed. Take note that in case of disconnection detect during Process() call disconnect handlers are called automatically.

Creates internal structures for newly registered namespace. You can register handlers for this namespace afterwards. By default one namespace already registered (jabber:client or jabber:component:accept depending on context.

Used to declare some top-level stanza name to dispatcher. Needed to start registering handlers for such stanzas. Iq, message and presence protocols are registered by default.

Register user callback as stanzas handler of declared type. Callback must take
(if chained, see later) arguments: dispatcher instance (for replying), incomed
return of previous handlers.
The callback must raise xmpp.NodeProcessed just before return if it want preven
callbacks to be called with the same stanza as argument _and_, more importantly
library from returning stanza to sender with error set (to be enabled in 0.2 ve
 Arguments:
   "name" - name of stanza. F.e. "iq".
   "handler" - user callback.
   "typ" - value of stanza's "type" attribute. If not specified any value match
   "ns" - namespace of child that stanza must contain.
   "chained" - chain together output of several handlers.
   "makefirst" - insert handler in the beginning of handlers list instead of
     adding it to the end. Note that more common handlers (i.e. w/o "typ" and "
     will be called first nevertheless.
   "system" - call handler even if NodeProcessed Exception were raised already.
 

Unregister handler. "typ" and "ns" must be specified exactly the same as with registering.

Specify the handler that will be used if no NodeProcessed exception were raised. This is returnStanzaHandler by default.

Register handler that will process events. F.e. "FILERECEIVED" event.

Raise some event. Takes three arguments: 1) "realm" - scope of event. Usually a namespace. 2) "event" - the event itself. F.e. "SUCESSFULL SEND". 3) data that comes along with event. Depends on event.

Main procedure that performs XMPP stanza recognition and calling apppropriate handlers for it. Called internally.

Block and wait until stanza with specific "id" attribute will come. If no such stanza is arrived within timeout, return None. If operation failed for some reason then owner's attributes lastErrNode, lastErr and lastErrCode are set accordingly.

Put stanza on the wire and call back when recipient replies. Additional callback arguments can be specified in args.

Serialise stanza and put it on the wire. Assign an unique ID to it before send. Returns assigned ID.