summaryrefslogtreecommitdiff
path: root/docs/glossary.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/glossary.rst')
-rw-r--r--docs/glossary.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst
new file mode 100644
index 00000000..35d2dc86
--- /dev/null
+++ b/docs/glossary.rst
@@ -0,0 +1,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`