PikeAero::CEventQueue Class Reference

#include <ceventqueue.h>

Collaboration diagram for PikeAero::CEventQueue:

[legend]

Static Public Member Functions
static CMachine::ubit32	deliveryCount ()
static void	dequeue ()
	dispatch some events in the current task's time slice
static CMachine::ubit32	dequeueCount ()
static void	enqueue (CEvent *e)
	enqueue an event for later dispatch. CEventQueue has event ownership and will delete it.
static CMachine::ubit32	enqueueCount ()
static void	initialize ()
static void	installListener (CObject *object, CEvent::Type type)
	install an event listener
static CMachine::ubit32	maxInQueue ()
static void	removeListener (CObject *object, CEvent::Type type)
	remove an event listener
static void	resetDeliveryCount ()
static void	resetDequeueCount ()
static void	resetEnqueueCount ()
static void	resetMaxInQueue ()
Static Protected Member Functions
static void	dispatch (CEvent *e)
	dispatch a particular event, CEventQueue has event ownership and will delete the event after dispatch
Static Private Attributes
static CMachine::ubit32	mDeliveryCount
static CMachine::ubit32	mDequeueCount
static CMachine::ubit32	mEnqueueCount
static CObjectQueue *	mEventQueue = NULL
static CObjectList **	mListenerMap = NULL
static CMachine::ubit32	mMaxInQueue

---

Detailed Description

Implements queueing and dispatching events.

Author:

Michael Sharkey <mike@pikeaero.com>

Definition at line 35 of file ceventqueue.h.

---

Member Function Documentation

static CMachine::ubit32 PikeAero::CEventQueue::deliveryCount

(

)

[inline, static]

Definition at line 55 of file ceventqueue.h.

References mDeliveryCount.

Referenced by PikeAero::CTaskAggregator::perSecond().

{return mDeliveryCount;}

Here is the caller graph for this function:

void PikeAero::CEventQueue::dequeue

(

)

[static]

dispatch some events in the current task's time slice

Definition at line 70 of file ceventqueue.cpp.

References PikeAero::CObjectList::count(), PikeAero::CObjectQueue::dequeue(), dispatch(), mDequeueCount, mEventQueue, mMaxInQueue, and PikeAero::CMachine::resetWatchDog().

Referenced by PikeAero::CTaskSupervisor::run().

{
    CMachine::bit32 count = mEventQueue->count();
    mMaxInQueue = (mMaxInQueue >= count) ? mMaxInQueue : count;

    while ( mEventQueue->count() )
    {
        CEvent* e = static_cast<CEvent*>(mEventQueue->dequeue());
        CMachine::resetWatchDog();
        ++mDequeueCount;
        dispatch( e );
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

static CMachine::ubit32 PikeAero::CEventQueue::dequeueCount

(

)

[inline, static]

Definition at line 52 of file ceventqueue.h.

References mDequeueCount.

Referenced by PikeAero::CTaskAggregator::perSecond().

{return mDequeueCount;}

Here is the caller graph for this function:

void PikeAero::CEventQueue::dispatch

(

CEvent *

e

)

[static, protected]

dispatch a particular event, CEventQueue has event ownership and will delete the event after dispatch

Event handler must not take ownership of the event object, but must make a copy if nessesary

then we delete the event object

Definition at line 111 of file ceventqueue.cpp.

References PikeAero::CObjectList::at(), PikeAero::CObjectList::count(), PikeAero::CObject::event(), mDeliveryCount, mListenerMap, and PikeAero::CMachine::resetWatchDog().

Referenced by dequeue().

{
    CEvent::Type type = ((CEvent*)e)->type();
    CObjectList* list = static_cast<CObjectList*>(mListenerMap[type]);
    for ( CMachine::ubit32 n=0; n < list->count(); n++ )
    {
        /** Event handler must not take ownership of the event object, but must make a copy if nessesary */
        list->at(n)->event(e);
        ++mDeliveryCount;
        CMachine::resetWatchDog();
    }
    /** then we delete the event object */
    delete e;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void PikeAero::CEventQueue::enqueue

(

CEvent *

e

)

[static]

enqueue an event for later dispatch. CEventQueue has event ownership and will delete it.

public interface to atomic methods

Only enqueue the event if somebody is listening to it's type...

jump the queue - LIFO mode

TODO - load testing required. test threshold where flooding hi priority events begins to starve the queue.

normal/low priority - FIFO mode.

Definition at line 85 of file ceventqueue.cpp.

References PikeAero::CObjectList::append(), PikeAero::CObjectList::count(), PikeAero::CObjectList::insert(), mEnqueueCount, mEventQueue, mListenerMap, PikeAero::CEvent::PriorityHigh, and PikeAero::CEvent::type().

Referenced by PikeAero::CObject::dispatch().

{
    /** Only enqueue the event if somebody is listening to it's type... */
    CObjectList* list = static_cast<CObjectList*>(mListenerMap[e->type()]);
    if ( list->count() > 0 )
    {
        ++mEnqueueCount;
        if ( ((CEvent*)e)->priority() == CEvent::PriorityHigh )
        {
            /** jump the queue - LIFO mode */
            /** TODO - load testing required. test threshold where flooding hi priority events begins to starve the queue. */
            mEventQueue->insert(e,0);
        }
        else
        {
            /** normal/low priority - FIFO mode. */
            mEventQueue->append(e);
        }
    }
    else
    {
        delete e;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

static CMachine::ubit32 PikeAero::CEventQueue::enqueueCount

(

)

[inline, static]

Definition at line 49 of file ceventqueue.h.

References mEnqueueCount.

Referenced by PikeAero::CTaskAggregator::perSecond().

{return mEnqueueCount;}

Here is the caller graph for this function:

void PikeAero::CEventQueue::initialize

(

)

[static]

perform CEventQueue initialization

initialize the event queue

initialize the listeners - allocate a table to the size of the maximum event type enumerator

instantiate an object list for each event type

Definition at line 37 of file ceventqueue.cpp.

References PikeAero::CMemHeap::malloc(), PikeAero::CEvent::Maximum, mDeliveryCount, mDequeueCount, mEnqueueCount, mEventQueue, mListenerMap, and mMaxInQueue.

Referenced by main().

{
    mMaxInQueue = 0;
    mEnqueueCount = 0;
    mDequeueCount = 0;
    mDeliveryCount = 0;

    /** initialize the event queue */
    mEventQueue = new CObjectQueue();
    /** initialize the listeners - allocate a table to the size of the maximum event type enumerator */
    mListenerMap=static_cast<CObjectList**>(CMemHeap::malloc( sizeof(CObjectList*) * CEvent::Maximum ));
    for ( int n=0; n < (int)CEvent::Maximum; n++ )
    {
        /** instantiate an object list for each event type */
        mListenerMap[n] = new CObjectList();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void PikeAero::CEventQueue::installListener	(	CObject *	object,
		CEvent::Type	type
	)			[static]

install an event listener

TODO - need a mutex here?

Definition at line 56 of file ceventqueue.cpp.

References PikeAero::CObjectList::append(), and mListenerMap.

Referenced by PikeAero::CCommunicationPacket::CCommunicationPacket(), PikeAero::CTaskFuelPressureMonitor::start(), PikeAero::CTaskFuelInjection::start(), PikeAero::CTaskConsoleBase::start(), PikeAero::CTaskAnalogInputADC::start(), and PikeAero::CTaskAggregator::start().

{
    /** TODO - need a mutex here? */
    mListenerMap[type]->append( object );
}

Here is the call graph for this function:

Here is the caller graph for this function:

static CMachine::ubit32 PikeAero::CEventQueue::maxInQueue

(

)

[inline, static]

Definition at line 46 of file ceventqueue.h.

References mMaxInQueue.

Referenced by PikeAero::CTaskAggregator::perSecond().

{return mMaxInQueue;}

Here is the caller graph for this function:

void PikeAero::CEventQueue::removeListener	(	CObject *	object,
		CEvent::Type	type
	)			[static]

remove an event listener

TODO - need a mutex here?

Definition at line 63 of file ceventqueue.cpp.

References mListenerMap, and PikeAero::CObjectList::remove().

Referenced by PikeAero::CTaskSupervisor::stop(), PikeAero::CTaskFuelInjection::stop(), PikeAero::CTaskConsoleBase::stop(), PikeAero::CTaskAggregator::stop(), PikeAero::CCommunicationPacket::~CCommunicationPacket(), PikeAero::CTaskAnalogInputADC::~CTaskAnalogInputADC(), and PikeAero::CTaskFuelPressureMonitor::~CTaskFuelPressureMonitor().

{
    /** TODO - need a mutex here? */
    mListenerMap[type]->remove( object );
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void PikeAero::CEventQueue::resetDeliveryCount

(

)

[inline, static]

Definition at line 56 of file ceventqueue.h.

References mDeliveryCount.

Referenced by PikeAero::CTaskAggregator::perSecond().

{mDeliveryCount=0;}

Here is the caller graph for this function:

static void PikeAero::CEventQueue::resetDequeueCount

(

)

[inline, static]

Definition at line 53 of file ceventqueue.h.

References mDequeueCount.

Referenced by PikeAero::CTaskAggregator::perSecond().

{mDequeueCount=0;}

Here is the caller graph for this function:

static void PikeAero::CEventQueue::resetEnqueueCount

(

)

[inline, static]

Definition at line 50 of file ceventqueue.h.

References mEnqueueCount.

Referenced by PikeAero::CTaskAggregator::perSecond().

{mEnqueueCount=0;}

Here is the caller graph for this function:

static void PikeAero::CEventQueue::resetMaxInQueue

(

)

[inline, static]

Definition at line 47 of file ceventqueue.h.

References mMaxInQueue.

Referenced by PikeAero::CTaskAggregator::perSecond().

{mMaxInQueue=0;}

Here is the caller graph for this function:

---

Field Documentation

CMachine::ubit32 PikeAero::CEventQueue::mDeliveryCount [static, private]

Definition at line 65 of file ceventqueue.h.

Referenced by deliveryCount(), dispatch(), initialize(), and resetDeliveryCount().

CMachine::ubit32 PikeAero::CEventQueue::mDequeueCount [static, private]

Definition at line 64 of file ceventqueue.h.

Referenced by dequeue(), dequeueCount(), initialize(), and resetDequeueCount().

CMachine::ubit32 PikeAero::CEventQueue::mEnqueueCount [static, private]

Definition at line 63 of file ceventqueue.h.

Referenced by enqueue(), enqueueCount(), initialize(), and resetEnqueueCount().

CObjectQueue * PikeAero::CEventQueue::mEventQueue = NULL [static, private]

Definition at line 66 of file ceventqueue.h.

Referenced by dequeue(), enqueue(), and initialize().

CObjectList ** PikeAero::CEventQueue::mListenerMap = NULL [static, private]

Definition at line 67 of file ceventqueue.h.

Referenced by dispatch(), enqueue(), initialize(), installListener(), and removeListener().

CMachine::ubit32 PikeAero::CEventQueue::mMaxInQueue [static, private]

Definition at line 62 of file ceventqueue.h.

Referenced by dequeue(), initialize(), maxInQueue(), and resetMaxInQueue().

---

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

• ceventqueue.h
• ceventqueue.cpp