AnCH Framework 0.1
Another C++ Hack Framework
Loading...
Searching...
No Matches
anch::events::EventHandler< T, Derived > Class Template Reference

An event handler. More...

#include <eventHandler.hpp>

Inheritance diagram for anch::events::EventHandler< T, Derived >:
Collaboration diagram for anch::events::EventHandler< T, Derived >:

Public Member Functions

 EventHandler (const std::function< void(Derived &, const anch::events::Event< T > &)> &callbackFunction, bool useEventBus=false)
 EventHandler (const std::function< void(Derived &, const anch::events::Event< T > &)> &callbackFunction, anch::events::EventBus< T > &eventBus)
virtual ~EventHandler ()
virtual void handle (const anch::events::Event< T > &event) noexcept

Detailed Description

template<typename T, typename Derived>
class anch::events::EventHandler< T, Derived >

An event handler.

It provides a simple way to inherits several times from Observer and cutomize event receiving method name.

Since
0.1
Author
Vincent Lachenal

Constructor & Destructor Documentation

◆ EventHandler() [1/2]

template<typename T, typename Derived>
anch::events::EventHandler< T, Derived >::EventHandler ( const std::function< void(Derived &, const anch::events::Event< T > &)> & callbackFunction,
bool useEventBus = false )

EventHandler constructor.
Register callback method.
Register itself in global EventBus if set.

Parameters
callbackFunctionthe callback method to use on notify
useEventBusif true register itself in global EventBus, false otherwise (default)

◆ EventHandler() [2/2]

template<typename T, typename Derived>
anch::events::EventHandler< T, Derived >::EventHandler ( const std::function< void(Derived &, const anch::events::Event< T > &)> & callbackFunction,
anch::events::EventBus< T > & eventBus )

EventHandler constructor.
Registers callback method.
Register itself in EventBus.

Parameters
callbackFunctionthe callback method to use on notify
eventBusthe EventBus to register itself

◆ ~EventHandler()

template<typename T, typename Derived>
virtual anch::events::EventHandler< T, Derived >::~EventHandler ( )
virtual

EventHandler destructor.
Unregister EventHandler from EventBus if needed.

Member Function Documentation

◆ handle()

template<typename T, typename Derived>
virtual void anch::events::EventHandler< T, Derived >::handle ( const anch::events::Event< T > & event)
virtualnoexcept

Invokes callback method on receiving event.

Parameters
eventthe event which has been fired

Implements anch::events::Observer< T >.

The documentation for this class was generated from the following file: