summaryrefslogtreecommitdiff
path: root/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/pidfile.rst
blob: 3c02a0cee3169f6b49fc50d84a5b0bcd526ae7df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
*********
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: