From 43e9e51ed6c49e865b939c3c16f8f30588ca6cd5 Mon Sep 17 00:00:00 2001 From: David Wilson Date: Fri, 4 May 2018 03:47:29 +0100 Subject: [PATCH] docs: link signals into internals.rst. --- docs/internals.rst | 11 +++++++++++ docs/signals.rst | 11 ++++++++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/internals.rst b/docs/internals.rst index d22053c8..f3771343 100644 --- a/docs/internals.rst +++ b/docs/internals.rst @@ -2,6 +2,11 @@ Internal API Reference ********************** +.. toctree:: + :hidden: + + signals + mitogen.core ============ @@ -462,3 +467,9 @@ Helper Functions :returns str: The minimized source. + + +Signals +======= + +:ref:`Please refer to Signals `. diff --git a/docs/signals.rst b/docs/signals.rst index 8a314b5c..1c41353a 100644 --- a/docs/signals.rst +++ b/docs/signals.rst @@ -1,11 +1,20 @@ +.. _signals: + Signals ======= -Mitogen exposes a simplistic signal mechanism to help decouple its internal +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 ---------