EventHandler Class Reference
[EventTimer event handling]

SocketHandler implementing the IEventHandler interface. More...

#include <EventHandler.h>

Inheritance diagram for EventHandler:

[legend]

Collaboration diagram for EventHandler:

[legend]

List of all members.

Public Member Functions
	EventHandler (StdLog *=NULL)
	EventHandler (IMutex &, StdLog *=NULL)
	~EventHandler ()
bool	GetTimeUntilNextEvent (struct timeval *tv)
	Return time left until next event.
void	CheckEvents ()
	Will fire events whose time has come.
long	AddEvent (IEventOwner *from, long sec, long usec)
	Schedule event for an owner.
void	ClearEvents (IEventOwner *from)
	Clear all events for a specific owner.
void	RemoveEvent (IEventOwner *from, long eid)
	Remove one specific event for an event owner.
void	EventLoop ()
	SocketHandler while() loop implemented with event functionality.
void	SetQuit (bool=true)
	Stop event loop.
void	Add (Socket *)
	Add socket instance to socket map.
Private Member Functions
	EventHandler (const EventHandler &)
EventHandler &	operator= (const EventHandler &)
Private Attributes
std::list< Event * >	m_events
bool	m_quit

---

Detailed Description

SocketHandler implementing the IEventHandler interface.

Definition at line 51 of file EventHandler.h.

---

Constructor & Destructor Documentation

EventHandler::EventHandler

(

StdLog *

p = NULL

)

Definition at line 47 of file EventHandler.cpp.

References SocketHandler::EnableRelease().

                                    : SocketHandler(p), m_quit(false)
{
        EnableRelease();
}

EventHandler::EventHandler	(	IMutex &	m,
		StdLog *	p = NULL
	)

Definition at line 53 of file EventHandler.cpp.

References SocketHandler::EnableRelease().

                                              : SocketHandler(m, p), m_quit(false)
{
        EnableRelease();
}

EventHandler::~EventHandler

(

)

Definition at line 59 of file EventHandler.cpp.

References m_events.

{
        while (m_events.size())
        {
                std::list<Event *>::iterator it = m_events.begin();
                Event *e = *it;
                e -> GetFrom() -> SetHandlerInvalid();
                delete e;
                m_events.erase(it);
        }
}

EventHandler::EventHandler

(

const EventHandler &

)

[inline, private]

Definition at line 72 of file EventHandler.h.

{} // copy constructor

---

Member Function Documentation

bool EventHandler::GetTimeUntilNextEvent

(

struct timeval *

)

[virtual]

Return time left until next event.

Parameters:

tv

Time struct that will be filled by method

Returns:

true if time is set for next event

Implements IEventHandler.

Definition at line 72 of file EventHandler.cpp.

References m_events.

Referenced by EventLoop().

{
        if (!m_events.size())
                return false;
        std::list<Event *>::iterator it = m_events.begin();
        if (it != m_events.end())
        {
                EventTime now;
                mytime_t diff = (*it) -> GetTime() - now;
                if (diff < 1)
                {
                        diff = 1;
                }
                tv -> tv_sec = static_cast<long>(diff / 1000000);
                tv -> tv_usec = static_cast<long>(diff % 1000000);
                return true;
        }
        return false;
}

void EventHandler::CheckEvents

(

)

[virtual]

Will fire events whose time has come.

Implements IEventHandler.

Definition at line 93 of file EventHandler.cpp.

References m_events, and SocketHandler::Valid().

Referenced by EventLoop().

{
        EventTime now;
        std::list<Event *>::iterator it = m_events.begin();
        while (it != m_events.end() && (*it) -> GetTime() < now)
        {
                Event *e = *it;
                Socket *s = dynamic_cast<Socket *>(e -> GetFrom());
                /*
                s == NULL    This is another object implementing 'IEventOwner' and not a socket.
                s != NULL    This is a Socket implementing IEventOwner, and we can check that the
                             object instance still is valid using SocketHandler::Valid.
                */
                if (!s || (s && Valid( e -> Data() )))
                {
                        e -> GetFrom() -> OnEvent(e -> GetID());
                }
                for (it = m_events.begin(); it != m_events.end(); ++it)
                        if (*it == e)
                        {
                                delete e;
                                break;
                        }
                if (it != m_events.end())
                        m_events.erase(it);
                it = m_events.begin();
        }
}

long EventHandler::AddEvent	(	IEventOwner *	,
		long	sec,
		long	usec
	)			[virtual]

Schedule event for an owner.

Parameters:

	from	Event owner
	sec	Seconds until event
	usec	Microseconds until event

Implements IEventHandler.

Definition at line 123 of file EventHandler.cpp.

References m_events, and SocketHandler::Release().

{
        Socket *s = dynamic_cast<Socket *>(from);
        Event *e = new Event(from, sec, usec, s ? s -> UniqueIdentifier() : 0);
        std::list<Event *>::iterator it = m_events.begin();
        while (it != m_events.end() && *(*it) < *e)
        {
                ++it;
        }
        m_events.insert(it, e);
        Release();
        return e -> GetID();
}

void EventHandler::ClearEvents

(

IEventOwner *

)

[virtual]

Clear all events for a specific owner.

Implements IEventHandler.

Definition at line 138 of file EventHandler.cpp.

References m_events.

{
        bool repeat;
        do
        {
                repeat = false;
                for (std::list<Event *>::iterator it = m_events.begin(); it != m_events.end(); ++it)
                {
                        Event *e = *it;
                        if (e -> GetFrom() == from)
                        {
                                delete e;
                                m_events.erase(it);
                                repeat = true;
                                break;
                        }
                }
        } while (repeat);
}

void EventHandler::RemoveEvent	(	IEventOwner *	,
		long
	)			[virtual]

Remove one specific event for an event owner.

Implements IEventHandler.

Definition at line 183 of file EventHandler.cpp.

References m_events.

{
        for (std::list<Event *>::iterator it = m_events.begin(); it != m_events.end(); ++it)
        {
                Event *e = *it;
                if (from == e -> GetFrom() && eid == e -> GetID())
                {
                        delete e;
                        m_events.erase(it);
                        break;
                }
        }
}

void EventHandler::EventLoop

(

)

SocketHandler while() loop implemented with event functionality.

Definition at line 159 of file EventHandler.cpp.

References CheckEvents(), GetTimeUntilNextEvent(), m_quit, and SocketHandler::Select().

{
        while (!m_quit)
        {
                struct timeval tv;
                if (GetTimeUntilNextEvent(&tv))
                {
                        Select(&tv);
                        CheckEvents();
                }
                else
                {
                        Select();
                }
        }
}

void EventHandler::SetQuit

(

bool

x = true

)

Stop event loop.

Definition at line 177 of file EventHandler.cpp.

References m_quit.

{
        m_quit = x;
}

void EventHandler::Add

(

Socket *

p

)

[virtual]

Add socket instance to socket map.

Removal is always automatic.

Reimplemented from SocketHandler.

Definition at line 198 of file EventHandler.cpp.

References SocketHandler::Add().

{
        SocketHandler::Add( p );
}

EventHandler& EventHandler::operator=

(

const EventHandler &

)

[inline, private]

Definition at line 73 of file EventHandler.h.

{ return *this; } // assignment operator

---

Member Data Documentation

std::list<Event *> EventHandler::m_events [private]

Definition at line 74 of file EventHandler.h.

Referenced by AddEvent(), CheckEvents(), ClearEvents(), GetTimeUntilNextEvent(), RemoveEvent(), and ~EventHandler().

bool EventHandler::m_quit [private]

Definition at line 75 of file EventHandler.h.

Referenced by EventLoop(), and SetQuit().

---

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

• EventHandler.h
• EventHandler.cpp