diff options
Diffstat (limited to 'vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins')
5 files changed, 0 insertions, 177 deletions
diff --git a/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/daemonizer.rst b/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/daemonizer.rst deleted file mode 100644 index a5296ce..0000000 --- a/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/daemonizer.rst +++ /dev/null @@ -1,47 +0,0 @@ -*************** -Run as a daemon -*************** - -CherryPy allows you to easily decouple the current process from the parent -environment, using the traditional double-fork:: - - from cherrypy.process.plugins import Daemonizer - d = Daemonizer(cherrypy.engine) - d.subscribe() - -.. note:: - - This :ref:`Engine Plugin<plugins>` is only available on - Unix and similar systems which provide fork(). - -If a startup error occurs in the forked children, the return code from the -parent process will still be 0. Errors in the initial daemonizing process still -return proper exit codes, but errors after the fork won't. Therefore, if you use -this plugin to daemonize, don't use the return code as an accurate indicator of -whether the process fully started. In fact, that return code only indicates if -the process successfully finished the first fork. - -The plugin takes optional arguments to redirect standard streams: ``stdin``, -``stdout``, and ``stderr``. By default, these are all redirected to -:file:`/dev/null`, but you're free to send them to log files or elsewhere. - -.. warning:: - - You should be careful to not start any threads before this plugin runs. - The plugin will warn if you do so, because "...the effects of calling functions - that require certain resources between the call to fork() and the call to an - exec function are undefined". (`ref <http://www.opengroup.org/onlinepubs/000095399/functions/fork.html>`_). - It is for this reason that the Server plugin runs at priority 75 (it starts - worker threads), which is later than the default priority of 65 for the - Daemonizer. - - -.. currentmodule:: cherrypy.process.plugins - -Classes -======= - -.. autoclass:: Daemonizer - :members: - :show-inheritance: - diff --git a/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/dropprivileges.rst b/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/dropprivileges.rst deleted file mode 100644 index daaa1ef..0000000 --- a/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/dropprivileges.rst +++ /dev/null @@ -1,25 +0,0 @@ -*************** -Drop privileges -*************** - -Use this :ref:`Engine Plugin<plugins>` to start your -CherryPy site as root (for example, to listen on a privileged port like 80) -and then reduce privileges to something more restricted. - -This priority of this plugin's "start" listener is slightly higher than the -priority for ``server.start`` in order to facilitate the most common use: -starting on a low port (which requires root) and then dropping to another user. - -Example:: - - DropPrivileges(cherrypy.engine, '/var/run/myapp.pid').subscribe() - -.. currentmodule:: cherrypy.process.plugins - -Classes -======= - -.. autoclass:: DropPrivileges - :members: - :show-inheritance: - diff --git a/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/index.rst b/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/index.rst deleted file mode 100644 index a2ebb16..0000000 --- a/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/index.rst +++ /dev/null @@ -1,46 +0,0 @@ -************************************************* -:mod:`cherrypy.process.plugins` -- Engine Plugins -************************************************* - -.. automodule:: cherrypy.process.plugins - -Classes -======= - -.. autoclass:: SimplePlugin - :members: - -.. autoclass:: ThreadManager - :members: - :show-inheritance: - -Monitors --------- - -.. autoclass:: BackgroundTask - :members: - -.. autoclass:: PerpetualTimer - :members: - -.. autoclass:: Monitor - :members: - :show-inheritance: - -.. autoclass:: Autoreloader - :members: - :inherited-members: - :show-inheritance: - - -Other Plugins -------------- - -.. toctree:: - :maxdepth: 2 - - signalhandler - dropprivileges - daemonizer - pidfile - diff --git a/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/pidfile.rst b/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/pidfile.rst deleted file mode 100644 index 3c02a0c..0000000 --- a/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/pidfile.rst +++ /dev/null @@ -1,20 +0,0 @@ -********* -PID files -********* - -The PIDFile :ref:`Engine Plugin<plugins>` is pretty straightforward: it writes -the process id to a file on start, and deletes the file on exit. You must -provide a 'pidfile' argument, preferably an absolute path:: - - PIDFile(cherrypy.engine, '/var/run/myapp.pid').subscribe() - -.. currentmodule:: cherrypy.process.plugins - -Classes -======= - -.. autoclass:: PIDFile - :members: - :show-inheritance: - - 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 deleted file mode 100644 index 5e8ced3..0000000 --- a/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/signalhandler.rst +++ /dev/null @@ -1,39 +0,0 @@ -**************** -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. - |