Leviathan::EventHandler Class Reference

Allows object to register for events that can be fired from anywhere. More...

#include <EventHandler.h>

Inheritance diagram for Leviathan::EventHandler:

Public Member Functions
DLLEXPORT	EventHandler ()
DLLEXPORT	~EventHandler ()
DLLEXPORT bool	Init ()
DLLEXPORT void	Release ()
DLLEXPORT void	CallEvent (Event *event)
DLLEXPORT void	CallEvent (const Event::pointer &event)
DLLEXPORT void	CallEvent (GenericEvent *event)
DLLEXPORT void	CallEvent (const GenericEvent::pointer &event)
DLLEXPORT bool	RegisterForEvent (CallableObject *toregister, EVENT_TYPE totype)
DLLEXPORT bool	RegisterForEvent (CallableObject *toregister, const std::string &genericname)
DLLEXPORT void	Unregister (CallableObject *caller, EVENT_TYPE type, bool all=false)
DLLEXPORT void	Unregister (CallableObject *caller, const std::string &genericname, bool all=false)
Public Member Functions inherited from Leviathan::ThreadSafeGeneric< MutexType >
DLLEXPORT	ThreadSafeGeneric ()
DLLEXPORT	~ThreadSafeGeneric ()
FORCE_INLINE void	VerifyLock (RecursiveLock &guard) const
FORCE_INLINE void	VerifyLock (Lock &lockit) const

Additional Inherited Members
Protected Attributes inherited from Leviathan::ThreadSafeGeneric< MutexType >
MutexType	ObjectsLock

Detailed Description

Allows object to register for events that can be fired from anywhere.

This is recursive to allow EventCallbacks to also fire events. This makes it possible to cause a stackoverflow but makes it easier to make events that fire a different event

Definition at line 15 of file EventHandler.h.

Constructor & Destructor Documentation

EventHandler()

EventHandler::EventHandler

(

)

Definition at line 6 of file EventHandler.cpp.

                          {

}

~EventHandler()

EventHandler::~EventHandler

(

)

Definition at line 10 of file EventHandler.cpp.

                           {

}

Member Function Documentation

CallEvent() [1/4]

void EventHandler::CallEvent

(

Event *

event

)

Parameters

event

The event to send. Reference count will be decremented by this

Definition at line 28 of file EventHandler.cpp.

                                        {

    const auto type = event->GetType();

    GUARD_LOCK();

    for(auto iter = EventListeners.begin(); iter != EventListeners.end(); ){

        if(std::get<1>(*iter) == type){

            const auto result = std::get<0>(*iter)->OnEvent(event);

            if(result == -1){

                // Unregister requested //
                iter = EventListeners.erase(iter);
                continue;
            }
        }

        ++iter;
    }

    event->Release();
}

CallEvent() [2/4]

DLLEXPORT void Leviathan::EventHandler::CallEvent ( const Event::pointer &  event )

inline

Definition at line 25 of file EventHandler.h.

    {
        event->AddRef();
        CallEvent(event.get());
    }

CallEvent() [3/4]

DLLEXPORT void Leviathan::EventHandler::CallEvent

(

GenericEvent *

event

)

Parameters

event

The event to send. Reference count will be decremented by this

Definition at line 54 of file EventHandler.cpp.

                                                                  {

    const auto type = event->GetType();
    
    GUARD_LOCK();
    
    // Loop generic listeners //
    for(auto iter = GenericEventListeners.begin(); iter != GenericEventListeners.end(); ){

        if(std::get<1>(*iter) == type){

            const auto result = std::get<0>(*iter)->OnGenericEvent(event);

            if(result == -1){

                // Unregister requested //
                iter = GenericEventListeners.erase(iter);
                continue;
            }
        }

        ++iter;
    }

    event->Release();
}

CallEvent() [4/4]

DLLEXPORT void Leviathan::EventHandler::CallEvent ( const GenericEvent::pointer &  event )

inline

Todo:

Swap this with the function above to make this more efficient (and switch to using this)

Definition at line 35 of file EventHandler.h.

    {
        event->AddRef();
        CallEvent(event.get());
    }

Init()

bool EventHandler::Init

(

)

Definition at line 14 of file EventHandler.cpp.

                       {
    return true;
}

RegisterForEvent() [1/2]

bool EventHandler::RegisterForEvent	(	CallableObject *	toregister,
		EVENT_TYPE	totype
	)

Definition at line 81 of file EventHandler.cpp.

                                                                                {
    GUARD_LOCK();
    EventListeners.push_back(std::make_tuple(toregister, totype));
    return true;
}

RegisterForEvent() [2/2]

DLLEXPORT bool Leviathan::EventHandler::RegisterForEvent	(	CallableObject *	toregister,
		const std::string &	genericname
	)

Definition at line 87 of file EventHandler.cpp.

{
    GUARD_LOCK();
    GenericEventListeners.push_back(std::make_tuple(toregister, genericname));
    return true;
}

Release()

void EventHandler::Release

(

)

Definition at line 18 of file EventHandler.cpp.

                          {
    GUARD_LOCK();

    
    
    // Release listeners //
    EventListeners.clear();
    GenericEventListeners.clear();
}

Unregister() [1/2]

void EventHandler::Unregister	(	CallableObject *	caller,
		EVENT_TYPE	type,
		bool	all = false
	)

Definition at line 95 of file EventHandler.cpp.

                                                                              {
    GUARD_LOCK();
    
    // Loop and remove wanted objects //
    for(auto iter = EventListeners.begin(); iter != EventListeners.end(); ){

        if(std::get<0>(*iter) == caller){
    
            // check type or if all is specified delete //
            if(all || type == std::get<1>(*iter)){
                
                iter = EventListeners.erase(iter);
                continue;
            }
        }

        ++iter;
    }
}

Unregister() [2/2]

DLLEXPORT void Leviathan::EventHandler::Unregister	(	CallableObject *	caller,
		const std::string &	genericname,
		bool	all = false
	)

Definition at line 115 of file EventHandler.cpp.

{
    GUARD_LOCK();
    
    // Loop and remove wanted objects //
    for(auto iter = GenericEventListeners.begin(); iter != GenericEventListeners.end(); ){

        if(std::get<0>(*iter) == caller){
    
            // check type or if all is specified delete //
            if(all || genericname == std::get<1>(*iter)){
                
                iter = GenericEventListeners.erase(iter);
                continue;
            }
        }

        ++iter;
    }
}

---

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

• EventHandler.h
• EventHandler.cpp