You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
67 lines
1.7 KiB
ReStructuredText
67 lines
1.7 KiB
ReStructuredText
|
|
.. _signals:
|
|
|
|
Signals
|
|
=======
|
|
|
|
Mitogen contains a simplistic signal mechanism to help decouple its internal
|
|
components. When a signal is fired by a particular instance of a class, any
|
|
functions registered to receive it will be called back.
|
|
|
|
.. warning::
|
|
|
|
As signals execute on the Broker thread, and without exception handling,
|
|
they are generally unsafe for consumption by user code, as any bugs could
|
|
trigger crashes and hangs for which the broker is unable to forward logs,
|
|
or ensure the buggy context always shuts down on disconnect.
|
|
|
|
|
|
Functions
|
|
---------
|
|
|
|
.. function:: mitogen.core.listen (obj, name, func)
|
|
|
|
Arrange for `func(\*args, \*\*kwargs)` to be invoked when the named signal
|
|
is fired by `obj`.
|
|
|
|
.. function:: mitogen.core.fire (obj, name, \*args, \*\*kwargs)
|
|
|
|
Arrange for `func(\*args, \*\*kwargs)` to be invoked for every function
|
|
registered for the named signal on `obj`.
|
|
|
|
|
|
|
|
List
|
|
----
|
|
|
|
These signals are used internally by Mitogen.
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
:widths: auto
|
|
|
|
* - Class
|
|
- Name
|
|
- Description
|
|
|
|
* - :py:class:`mitogen.core.Stream`
|
|
- ``disconnect``
|
|
- Fired on the Broker thread when disconnection is detected.
|
|
|
|
* - :py:class:`mitogen.core.Context`
|
|
- ``disconnect``
|
|
- Fired on the Broker thread during shutdown (???)
|
|
|
|
* - :py:class:`mitogen.core.Router`
|
|
- ``shutdown``
|
|
- Fired on the Broker thread after Broker.shutdown() is called.
|
|
|
|
* - :py:class:`mitogen.core.Broker`
|
|
- ``shutdown``
|
|
- Fired after Broker.shutdown() is called.
|
|
|
|
* - :py:class:`mitogen.core.Broker`
|
|
- ``exit``
|
|
- Fired immediately prior to the broker thread exit.
|
|
|