#11109: clean up docs, add whatsnew entry, and fix Justin's last name.

This commit is contained in:
R David Murray 2012-10-01 21:43:46 -04:00
parent 7eb03ddf11
commit 258fabefde
4 changed files with 22 additions and 10 deletions

View file

@ -153,20 +153,22 @@ Server Objects
.. method:: BaseServer.serve_forever(poll_interval=0.5)
Handle requests until an explicit :meth:`shutdown` request.
Poll for shutdown every *poll_interval* seconds. Ignores :attr:`self.timeout`. It also calls
:meth:`service_actions` which may be used by a subclass or Mixin to provide
various cleanup actions. For e.g. ForkingMixin class uses
:meth:`service_actions` to cleanup the zombie child processes.
Handle requests until an explicit :meth:`shutdown` request. Poll for
shutdown every *poll_interval* seconds. Ignores :attr:`self.timeout`. It
also calls :meth:`service_actions`, which may be used by a subclass or mixin
to provide actions specific to a given service. For example, the
:class:`ForkingMixIn` class uses :meth:`service_actions` to clean up zombie
child processes.
.. versionchanged:: 3.3
Added service_actions call to the serve_forever method.
Added ``service_actions`` call to the ``serve_forever`` method.
.. method:: BaseServer.service_actions()
This is called by the serve_forever loop. This method is can be overridden
by Mixin's to add cleanup or service specific actions.
This is called in the :meth:`serve_forever` loop. This method is can be
overridden by subclasses or mixin classes to perform actions specific to
a given service, such as cleanup actions.
.. versionadded:: 3.3