File: glossary.rst

package info (click to toggle)
emesene 2.12.5+dfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 10,720 kB
  • ctags: 11,801
  • sloc: python: 73,633; makefile: 200; sh: 4; xml: 2
file content (35 lines) | stat: -rw-r--r-- 1,271 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
.. _glossary:

Glossary
========

.. glossary::
    :sorted:

    stream handler
        A callback function that accepts stanza objects pulled directly
        from the XML stream. A stream handler is encapsulated in a
        object that includes a :term:`Matcher` object, and which provides
        additional semantics. For example, the ``Waiter`` handler wrapper
        blocks thread execution until a matching stanza is received.

    event handler
        A callback function that responds to events raised by
        ``XMLStream.event``. An event handler may be marked as
        threaded, allowing it to execute outside of the main processing
        loop.

    stanza object
        Informally may refer both to classes which extend ``ElementBase``
        or ``StanzaBase``, and to objects of such classes.

        A stanza object is a wrapper for an XML object which exposes ``dict``
        like interfaces which may be assigned to, read from, or deleted.

    stanza plugin
        A :term:`stanza object` which has been registered as a potential child
        of another stanza object. The plugin stanza may accessed through the
        parent stanza using the plugin's ``plugin_attrib`` as an interface.

    substanza
        See :term:`stanza plugin`