.. _dispatcher:

.. include:: ../../defs.hrst

Dispatcher
##########

The dispatcher is responsible for collecting emitted events and calling listeners with the respective events.
In |Obscura| no particular base class is required for creating a listener. All you need is a class that implements
the defined callbacks. These callbacks are defined via :doc:`event_definitions`.

Configurable Dispatcher
-----------------------

.. doxygenclass:: obscura::ConfigurableDispatcher
   :members:
   :undoc-members:

Dispatcher Base Class
---------------------

Every :class:`obscura::ConfigurableDispatcher` inherits from the following base class.

.. doxygenclass:: obscura::DispatcherBase
   :members:
   :undoc-members:

Pre-configured Dispatcher
-------------------------

A predefined dispatcher is available via the following class.

.. doxygentypedef:: obscura::Dispatcher

Examples
--------

Configure a Custom Dispatcher
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. literalinclude:: ../../../../examples/use_custom_event.cxx
    :language: c++