AnCH Framework  0.1
Another C++ Hack Framework
Public Member Functions | Static Public Member Functions | Friends | List of all members
anch::events::EventBus< Event > Class Template Reference

A class which manage global events firing and events QoS. More...

#include <eventBus.hpp>

Inheritance diagram for anch::events::EventBus< Event >:
Collaboration diagram for anch::events::EventBus< Event >:

Public Member Functions

bool addObserver (anch::events::Observer< Event > &observer) noexcept
 
void removeObserver (anch::events::Observer< Event > &observer) noexcept
 
void fireEvent (const Event &event) noexcept
 
void scheduleDeferred (const Event &event) noexcept
 

Static Public Member Functions

static bool AddObserver (anch::events::Observer< Event > &observer) noexcept
 
static void RemoveObserver (anch::events::Observer< Event > &observer) noexcept
 
static void FireEvent (const Event &event) noexcept
 
static void ScheduleDeferred (const Event &event) noexcept
 
- Static Public Member Functions inherited from anch::Singleton< EventBus< Event > >
static EventBus< Event > & getInstance ()
 

Friends

class anch::Singleton< EventBus< Event > >
 

Detailed Description

template<typename Event>
class anch::events::EventBus< Event >

A class which manage global events firing and events QoS.

EventBus is a singleton.

Since
0.1
Author
Vincent Lachenal

Member Function Documentation

template<typename Event>
bool anch::events::EventBus< Event >::addObserver ( anch::events::Observer< Event > &  observer)
inlinenoexcept

Register Observer to EventBus

Parameters
observerthe Observer to register
template<typename Event>
static bool anch::events::EventBus< Event >::AddObserver ( anch::events::Observer< Event > &  observer)
inlinestaticnoexcept

Retrieve EventBus instance and register Observer to EventBus

Parameters
observerthe Observer to register
template<typename Event>
void anch::events::EventBus< Event >::fireEvent ( const Event &  event)
inlinenoexcept

Notify all observer that an event has been fired

Parameters
eventthe event which has been fired
template<typename Event>
static void anch::events::EventBus< Event >::FireEvent ( const Event &  event)
inlinestaticnoexcept

Retrieve EventBus instance and notify all observer that an event has been fired

Parameters
eventthe event which has been fired
template<typename Event>
void anch::events::EventBus< Event >::removeObserver ( anch::events::Observer< Event > &  observer)
inlinenoexcept

Remove observer for notifications

Parameters
observerThe observer to remove
template<typename Event>
static void anch::events::EventBus< Event >::RemoveObserver ( anch::events::Observer< Event > &  observer)
inlinestaticnoexcept

Retrieve EventBus instance and remove observer for notifications

Parameters
observerThe observer to remove
template<typename Event>
void anch::events::EventBus< Event >::scheduleDeferred ( const Event &  event)
inlinenoexcept

Put event in sheduler.

Parameters
eventthe event to process
template<typename Event>
static void anch::events::EventBus< Event >::ScheduleDeferred ( const Event &  event)
inlinestaticnoexcept

Retrieve EventBus instance and put event in sheduler.

Parameters
eventthe event to process

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