docs/glossary.rst

   1 .. _glossary:
   2
   3 Glossary
   4 ========
   5
   6 .. glossary::
   7     :sorted:
   8
   9     stream handler
  10         A callback function that accepts stanza objects pulled directly
  11         from the XML stream. A stream handler is encapsulated in a
  12         object that includes a :term:`Matcher` object, and which provides
  13         additional semantics. For example, the ``Waiter`` handler wrapper
  14         blocks thread execution until a matching stanza is received.
  15
  16     event handler
  17         A callback function that responds to events raised by
  18         ``XMLStream.event``. An event handler may be marked as
  19         threaded, allowing it to execute outside of the main processing
  20         loop.
  21
  22     stanza object
  23         Informally may refer both to classes which extend ``ElementBase``
  24         or ``StanzaBase``, and to objects of such classes.
  25
  26         A stanza object is a wrapper for an XML object which exposes ``dict``
  27         like interfaces which may be assigned to, read from, or deleted.
  28
  29     stanza plugin
  30         A :term:`stanza object` which has been registered as a potential child
  31         of another stanza object. The plugin stanza may accessed through the
  32         parent stanza using the plugin's ``plugin_attrib`` as an interface.
  33
  34     substanza
  35         See :term:`stanza plugin`