X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FPPI%2FEvents.hh;h=55a0e94e05ca19e6ca39b4846ab8dcb73c18efa6;hb=9cb871b939efe93e35dd96808d25089399acfc46;hp=1025db5204c6d1a0bad8a395a4b1faa188da0c63;hpb=3a43b572a2c0028b353d47e86fa7546633d6e2cf;p=senf.git diff --git a/senf/PPI/Events.hh b/senf/PPI/Events.hh index 1025db5..55a0e94 100644 --- a/senf/PPI/Events.hh +++ b/senf/PPI/Events.hh @@ -38,7 +38,7 @@ namespace senf { namespace ppi { namespace detail { class EventBindingBase; } - + /** \defgroup event_group Events Events provide notification of events outside the PPI framework: I/O activity, Timers @@ -49,13 +49,13 @@ namespace ppi { All events are derived from EventImplementation which is based on EventDescriptor. \see EventImplementation \n - \ref ppi_events + \ref ppi_events */ // Implementation: The concrete EventDescriptor implementation will need to set things up so // some callback (within the EventDescriptor implementation) will be called when the event // happens. This setup happens in 'v_enable()'. This internal handler sets up an EventType - // instance if needed and calls 'callback()'. + // instance if needed and calls 'callback()'. // // 'callback()' will access the EventBinding wrapper to find the user-callback to signal. It // will do any needed internal processing, call that user callback and clean up afterwards. @@ -65,7 +65,7 @@ namespace ppi { The EventDescriptor base-class provides an interface to control events. \see \ref ppi_events - */ + */ class EventDescriptor { public: @@ -100,7 +100,7 @@ namespace ppi { friend class ForwardingRoute; friend class detail::EventBindingBase; }; - + /** \brief Internal: Callback forwarders */ template @@ -121,7 +121,7 @@ namespace ppi { private: detail::EventBinding & binding(); }; - + #ifndef DOXYGEN template @@ -139,7 +139,7 @@ namespace ppi { /** \brief Event implementation base class - EventImplementation provides the base-class for all Event implementations. + EventImplementation provides the base-class for all Event implementations. \code class SomeEvent : public EventImplementation { @@ -157,7 +157,7 @@ namespace ppi { void cb() { // Build event argument - SomeEventArg arg (...); + SomeEventArg arg (...); // Call the event callback callback(arg); } @@ -176,7 +176,7 @@ namespace ppi { */ template class EventImplementation - : public EventDescriptor, + : public EventDescriptor, public EventImplementationHelper< EventType, EventImplementation > { public: @@ -185,7 +185,7 @@ namespace ppi { module::Module & module() const; ///< Module in which the event is registered EventManager & manager() const; ///< EventManager of the event - + protected: EventImplementation();