From 2ecc6f43a4492101d85c07935bc735932849d149 Mon Sep 17 00:00:00 2001 From: David Wilson Date: Wed, 28 Feb 2018 00:07:58 +0545 Subject: [PATCH] docs: Import, but do not yet link signals.rst --- docs/signals.rst | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/signals.rst diff --git a/docs/signals.rst b/docs/signals.rst new file mode 100644 index 00000000..a7548ac9 --- /dev/null +++ b/docs/signals.rst @@ -0,0 +1,38 @@ + +Signals +======= + + +.. 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` + - ``crash`` + - Fired when a crash occurs on the broker thread. Used by client apps to + hasten shutdown (e.g. by disconnect + + * - :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. +