diff options
Diffstat (limited to 'vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/signalhandler.rst')
-rw-r--r-- | vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/signalhandler.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/signalhandler.rst b/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/signalhandler.rst new file mode 100644 index 0000000..5e8ced3 --- /dev/null +++ b/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/signalhandler.rst @@ -0,0 +1,39 @@ +**************** +Handling Signals +**************** + +SignalHandler +============= + +This :ref:`Engine Plugin<plugins>` is instantiated automatically as +``cherrypy.engine.signal_handler``. +However, it is only *subscribed* automatically by ``cherrypy.quickstart()``. +So if you want signal handling and you're calling:: + + tree.mount(); engine.start(); engine.block() + +on your own, be sure to add:: + + if hasattr(cherrypy.engine, 'signal_handler'): + cherrypy.engine.signal_handler.subscribe() + +.. currentmodule:: cherrypy.process.plugins + +.. autoclass:: SignalHandler + :members: + + +.. index:: Windows, Ctrl-C, shutdown +.. _windows-console: + +Windows Console Events +====================== + +Microsoft Windows uses console events to communicate some signals, like Ctrl-C. +When deploying CherryPy on Windows platforms, you should obtain the +`Python for Windows Extensions <http://sourceforge.net/projects/pywin32/>`_; +once you have them installed, CherryPy will handle Ctrl-C and other +console events (CTRL_C_EVENT, CTRL_LOGOFF_EVENT, CTRL_BREAK_EVENT, +CTRL_SHUTDOWN_EVENT, and CTRL_CLOSE_EVENT) automatically, shutting down the +bus in preparation for process exit. + |