From 8f45bee662176e1b2a850a4a9fe25d26b03093a6 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 12 Sep 2010 12:45:07 +0000 Subject: - The BFG router now emits an additional event unconditionally at the end of request processing: ``repoze.bfg.interfaces.IFinishedRequest``. This event is meant to be used when it is necessary to perform unconditional cleanup after request processing. See the ``repoze.bfg.events.FinishedRequest`` class documentation for more information. - The ``repoze.bfg.interfaces.IWSGIApplicationCreatedEvent`` event interface was renamed to ``repoze.bfg.interfaces.IApplicationCreated``. Likewise, the ``repoze.bfg.events.WSGIApplicationCreatedEvent`` class was renamed to ``repoze.bfg.events.ApplicationCreated``. The older aliases will continue to work indefinitely. - The ``repoze.bfg.interfaces.IAfterTraversal`` event interface was renamed to ``repoze.bfg.interfaces.IContextFound``. Likewise, the ``repoze.bfg.events.AfterTraveral`` class was renamed to ``repoze.bfg.events.ContextFound``. The older aliases will continue to work indefinitely. --- docs/api/events.rst | 8 +++++++- docs/api/interfaces.rst | 6 +++--- 2 files changed, 10 insertions(+), 4 deletions(-) (limited to 'docs/api') diff --git a/docs/api/events.rst b/docs/api/events.rst index cad199be3..53fdeda86 100644 --- a/docs/api/events.rst +++ b/docs/api/events.rst @@ -10,14 +10,20 @@ Functions .. autofunction:: subscriber +.. _event_types: + Event Types ~~~~~~~~~~~ +.. autoclass:: ApplicationCreated + .. autoclass:: NewRequest +.. autoclass:: ContextFound + .. autoclass:: NewResponse -.. autoclass:: WSGIApplicationCreatedEvent +.. autoclass:: FinishedRequest See :ref:`events_chapter` for more information about how to register code which subscribes to these events. diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst index bda636940..974ab2ae9 100644 --- a/docs/api/interfaces.rst +++ b/docs/api/interfaces.rst @@ -8,13 +8,13 @@ Event-Related Interfaces ++++++++++++++++++++++++ - .. autointerface:: IAfterTraversal + .. autointerface:: IApplicationCreated .. autointerface:: INewRequest - .. autointerface:: INewResponse + .. autointerface:: IContextFound - .. autointerface:: IWSGIApplicationCreatedEvent + .. autointerface:: INewResponse Other Interfaces ++++++++++++++++ -- cgit v1.2.3