Homepage Demos Overview Downloads Tutorials Reference
Credits

EventRouter Class Reference

#include <EventRouter.h>

Inheritance diagram for EventRouter:

Inheritance graph
[legend]
List of all members.

Detailed Description

This class will handle distribution of events as well as management of timers.

Classes must inherit from EventListener and/or EventTrapper in order to receive events.

Use the global erouter EventRouter to post and subscribe to events, except if you are posting from within a MotionCommand, in which case you should use MotionCommand::postEvent() so that it will automatically be sent from the Motion process to the Main process.

When multiple listeners are subscribed, the order in which an event is distributed among them looks like this:

  1. "Specific" listeners: any listener which specifies a particular source id. (It doesn't matter if they specify a type id or not.)
    • older listeners get events before younger listeners
  2. "General" listeners: those that subscribe to an entire generator
    • older listeners get events before younger listeners

...but if you're relying on that ordering, there should be a cleaner way to do whatever you're doing.

If one behaviors unsubscribes another one during a processEvent(), that behavior may still get the "current" event before the unsubscription takes place. This is not a prescribed behavior, and also should not be relied on one way or the other.

Timer events are only sent to the generator which requested them. So if EventListener A requests a timer with ID 0 at two second intervals, and EventListener B requests a timer with ID 0 at three second intervals, each will still only receive the timers they requested - no cross talk. The timer generator is unique in this regard, which is why it is built in as an integral component of the EventRouter. All other events are broadcast.

If an EventListener/EventTrapper subscribes to the same event source multiple times, it will receive multiple copies of the event. However, the first call to removeListener for a source will remove all subscriptions to that source.
Example: EventListener A subscribes to (buttonEGID,*,*), and twice to (buttonEGID,0,*).

  • If button 0 is pressed, A will get three copies of the event.
  • If button 1 is pressed, A will get one copy.
  • If removeListener(&A,buttonEGID) is called, the (buttonEGID,*,*) is removed, as well as both of (buttonEGID,0,*).
  • If removeListener(&A,buttonEGID,0) is called, both of (buttonEGID,0,*) are removed, but (buttonEGID,*,*) would be untouched.

The buffered event distribution has not been tested thoroughly, and should be considered deprecated.

See also:
EventBase::EventGeneratorID_t for a complete listing of all generators, as well as instructions on how to add new generators.

Definition at line 66 of file EventRouter.h.

Public Member Functions

 EventRouter ()
 Constructs the router, buffertime defaults to 1.
virtual ~EventRouter ()
 just calls reset and removeAllTimers()
void reset ()
 erases all listeners, trappers and timers, resets EventRouter
void setBufferTime (unsigned int t)
 sets the time to wait between buffer clears, see EventRouter::buffertime
unsigned int getBufferTime ()
 returns the time to wait between buffer clears, see EventRouter::buffertime
Posting/Processing Events
void postEvent (EventBase::EventGeneratorID_t egid, unsigned int sid, EventBase::EventTypeID_t etid, unsigned int dur)
 recommended to create and post an event using current buffer setting
void postEvent (EventBase::EventGeneratorID_t egid, unsigned int sid, EventBase::EventTypeID_t etid, unsigned int dur, const std::string &n, float m)
 recommended to create and post an event using current buffer setting
void postEvent (EventBase *e)
 recommended to create and post an event using current buffer setting
void processTimers ()
 determines if timers need to be posted, and posts them if so.
void processEventBuffer ()
 clears the event buffer, deletes events as it does so.
void processEvent (const EventBase &e)
 forces unbuffered - sends event *now*. Will clear the buffer first if needed to ensure proper event ordering
Listener Detection
bool hasListeners (EventBase::EventGeneratorID_t egid)
 counts both listeners and trappers, so stuff can tell if it even needs to bother generating an event...
bool hasListeners (EventBase::EventGeneratorID_t egid, unsigned int sid)
 counts both listeners and trappers, so stuff can tell if it even needs to bother generating an event...
bool hasListeners (EventBase::EventGeneratorID_t egid, unsigned int sid, EventBase::EventTypeID_t etid)
 counts both listeners and trappers, so stuff can tell if it even needs to bother generating an event...
bool hasListeners (const EventBase &e)
 counts both listeners and trappers, so stuff can tell if it even needs to bother generating an event...
Timer Management
void addTimer (EventListener *el, unsigned int sid, unsigned int delay, bool repeat=true)
 adds a timer if it doesn't exist, or resets the timer if it already exists.
void addTimer (EventListener *el, const EventBase &e, bool repeat=true)
 calls the other addTimer() with the event's source id and duration, doesn't check to see if the generator is timerEGID
void removeTimer (EventListener *el)
 clears all pending timers for listener el
void removeTimer (EventListener *el, unsigned int sid)
 clears any pending timers with source id sid for listener el
void removeAllTimers ()
 clears all timers for all listeners
Listener Management
Adds a listener for all events from a given event generator

void addListener (EventListener *el, EventBase::EventGeneratorID_t egid)
void addListener (EventListener *el, EventBase::EventGeneratorID_t egid, unsigned int sid)
 Adds a listener for all types from a specific source and generator.
void addListener (EventListener *el, EventBase::EventGeneratorID_t egid, unsigned int sid, EventBase::EventTypeID_t etid)
void addListener (EventListener *el, const EventBase &e)
 Adds a listener for a specific source id and type from a given event generator, adding a Timer event will invoke addTimer(el, e.getSourceID(), e.getDuration(), true).
void removeListener (EventListener *el)
 stops sending ALL events to the listener, including timers
void removeListener (EventListener *el, EventBase::EventGeneratorID_t egid)
 stops sending specified events from the generator to the listener.
void removeListener (EventListener *el, EventBase::EventGeneratorID_t egid, unsigned int sid)
 stops sending specified events from the generator to the listener.
void removeListener (EventListener *el, EventBase::EventGeneratorID_t egid, unsigned int sid, EventBase::EventTypeID_t etid)
void removeListener (EventListener *el, const EventBase &e)
 stops sending specified events from the generator to the listener. If a timer is passed it will invoke removeTimer(el, e.getSourceID())
void forgetListener (EventListener *el) __attribute__((deprecated))
Trapper Management
Adds a trapper for a specific source id and type from a given event generator

void addTrapper (EventTrapper *el, const EventBase &e)
void addTrapper (EventTrapper *el, EventBase::EventGeneratorID_t egid)
 Adds a trapper for all events from a given event generator.
void addTrapper (EventTrapper *el, EventBase::EventGeneratorID_t egid, unsigned int sid)
 Adds a trapper for all types from a specific source and generator.
void addTrapper (EventTrapper *el, EventBase::EventGeneratorID_t egid, unsigned int sid, EventBase::EventTypeID_t etid)
 Adds a trapper for a specific source id and type from a given event generator.
void addTrapper (EventTrapper *el)
 adds a trapper for ALL events
void removeTrapper (EventTrapper *el, const EventBase &e)
 stops sending specified events from the generator to the trapper.
void removeTrapper (EventTrapper *el, EventBase::EventGeneratorID_t egid)
 stops sending specified events from the generator to the trapper.
void removeTrapper (EventTrapper *el, EventBase::EventGeneratorID_t egid, unsigned int sid)
 stops sending specified events from the generator to the trapper.
void removeTrapper (EventTrapper *el, EventBase::EventGeneratorID_t egid, unsigned int sid, EventBase::EventTypeID_t etid)
 stops sending specified events from the generator to the trapper.
void removeTrapper (EventTrapper *el)
 stops sending ALL events to the trapper

Protected Types

typedef std::vector< TimerEntry
* >::iterator 
timer_it_t
 makes code more readable

Protected Member Functions

void doSendBuffer ()
 does the work of clearing the buffer (calls doSendEvent() )
void doSendEvent (const EventBase &e)
 does the work of sending an event
void chkTimers ()
 just for debugging
void dispTimers ()
 just for debugging

Protected Attributes

std::vector< TimerEntry * > timers
 the list of timer entries being maintained, kept sorted by time they go active
std::vector< EventBase * > events
 used to store buffered events
bool doSendBufferLock
 in case of recursive calls to processEventBuffer()/doSendBuffer()
unsigned int lastBufClear
 time of last event buffer clear
unsigned int buffertime
 The time between clearings of the buffer.
EventMapper trappers
 A mapping of which EventTrapper's should get a chance to trap the event.
EventMapper listeners
 A mapping of which EventListener's should receive events.


Member Typedef Documentation

typedef std::vector<TimerEntry*>::iterator EventRouter::timer_it_t [protected]
 

makes code more readable

Definition at line 187 of file EventRouter.h.

Referenced by addTimer(), chkTimers(), dispTimers(), processTimers(), removeAllTimers(), and removeTimer().


Constructor & Destructor Documentation

EventRouter::EventRouter  ) 
 

Constructs the router, buffertime defaults to 1.

Definition at line 7 of file EventRouter.cc.

virtual EventRouter::~EventRouter  )  [inline, virtual]
 

just calls reset and removeAllTimers()

Definition at line 69 of file EventRouter.h.


Member Function Documentation

void EventRouter::addListener EventListener el,
const EventBase e
 

Adds a listener for a specific source id and type from a given event generator, adding a Timer event will invoke addTimer(el, e.getSourceID(), e.getDuration(), true).

Definition at line 123 of file EventRouter.cc.

void EventRouter::addListener EventListener el,
EventBase::EventGeneratorID_t  egid,
unsigned int  sid,
EventBase::EventTypeID_t  etid
 

Adds a listener for a specific source id and type from a given event generator

Definition at line 115 of file EventRouter.cc.

void EventRouter::addListener EventListener el,
EventBase::EventGeneratorID_t  egid,
unsigned int  sid
 

Adds a listener for all types from a specific source and generator.

Definition at line 106 of file EventRouter.cc.

void EventRouter::addListener EventListener el,
EventBase::EventGeneratorID_t  egid
 

Definition at line 98 of file EventRouter.cc.

Referenced by WalkCalibration::activate(), PostureEditor::activate(), BatteryCheckControl::activate(), SensorObserverControl::doSelect(), EventLogger::doSelect(), WorldStateVelDaemon::DoStart(), WorldStateSerializerBehavior::DoStart(), WMMonitorBehavior::DoStart(), WalkToTargetMachine::DoStart(), WalkControllerBehavior::DoStart(), VisualTargetTrans::DoStart(), VisualTargetCloseTrans::DoStart(), StareAtPawBehavior2::DoStart(), StareAtPawBehavior::DoStart(), StareAtBallBehavior::DoStart(), SoundTestBehavior::DoStart(), SoundNode::DoStart(), SimpleChaseBallBehavior::DoStart(), SegCamBehavior::DoStart(), RawCamBehavior::DoStart(), PlayMotionSequenceNode< SIZE >::DoStart(), MotionStressTestBehavior::DoStart(), MCRepeater::DoStart(), LookForSoundBehavior::DoStart(), KinematicSampleBehavior2::DoStart(), KinematicSampleBehavior::DoStart(), HeadPointerNode::DoStart(), HeadPointControllerBehavior::DoStart(), HeadLevelBehavior::DoStart(), GroundPlaneBehavior::DoStart(), FollowHeadBehavior::DoStart(), ExploreMachine::DoStart(), EventTrans::DoStart(), EventGeneratorBase::DoStart(), EStopControllerBehavior::DoStart(), DriveMeBehavior::DoStart(), Controller::DoStart(), CompletionTrans::DoStart(), CompareTrans< T >::DoStart(), ChaseBallBehavior::DoStart(), CameraBehavior::DoStart(), BatteryMonitorBehavior::DoStart(), BanditMachine::WaitNode::DoStart(), AutoGetupBehavior::DoStart(), ASCIIVisionBehavior::DoStart(), AlanBehavior::DoStart(), ValueEditControl< T >::pause(), MCRepeater::processEvent(), GroundPlaneBehavior::processEvent(), FollowHeadBehavior::processEvent(), AutoGetupBehavior::processEvent(), RunSequenceControl< SequenceSize >::selectedFile(), and LoadPostureControl::selectedFile().

void EventRouter::addTimer EventListener el,
const EventBase e,
bool  repeat = true
[inline]
 

calls the other addTimer() with the event's source id and duration, doesn't check to see if the generator is timerEGID

Definition at line 101 of file EventRouter.h.

void EventRouter::addTimer EventListener el,
unsigned int  sid,
unsigned int  delay,
bool  repeat = true
 

adds a timer if it doesn't exist, or resets the timer if it already exists.

timers are unique by EventListener and source ID - can't have two timers for the same el and sid
a delay of 0 with repeating will cause an event to be sent at every opportunity, use sparingly
a delay of -1U will call removeTimer() if it already exists, otherwise is ignored

To add a timer, you can also call addListener() with EventBase::timerEGID and the sid and delay (in the EventBase::duration field) - this method will simply cause this function to be called internally.

Parameters:
el the EventListener to send the timer event to
sid the source ID to use on that event (if you need to send more info, send a pointer to a struct of your devising, typecasted as int)
delay the delay between the first (and future) calls
repeat set to true if you want to keep receiving this event, otherwise it will only send once

Definition at line 53 of file EventRouter.cc.

Referenced by addListener(), addTimer(), NullTrans::DoStart(), DriveMeBehavior::DoStart(), BanditMachine::WaitNode::DoStart(), PostureEditor::processEvent(), DriveMeBehavior::processEvent(), BatteryMonitorBehavior::processEvent(), PostureEditor::refresh(), TimeOutTrans::resetTimer(), FreeMemReportControl::resetTimerFreq(), WalkControllerBehavior::runCommand(), HeadPointControllerBehavior::runCommand(), and BatteryMonitorBehavior::startWarning().

void EventRouter::addTrapper EventTrapper el  ) 
 

adds a trapper for ALL events

Note that since timers are not broadcast, they cannot be trapped. Only the EventListener which requested the timer will receive that timer.

Definition at line 239 of file EventRouter.cc.

void EventRouter::addTrapper EventTrapper el,
EventBase::EventGeneratorID_t  egid,
unsigned int  sid,
EventBase::EventTypeID_t  etid
 

Adds a trapper for a specific source id and type from a given event generator.

Note that since timers are not broadcast, they cannot be trapped. Only the EventListener which requested the timer will receive that timer.

Definition at line 229 of file EventRouter.cc.

void EventRouter::addTrapper EventTrapper el,
EventBase::EventGeneratorID_t  egid,
unsigned int  sid
 

Adds a trapper for all types from a specific source and generator.

Note that since timers are not broadcast, they cannot be trapped. Only the EventListener which requested the timer will receive that timer.

Definition at line 219 of file EventRouter.cc.

void EventRouter::addTrapper EventTrapper el,
EventBase::EventGeneratorID_t  egid
 

Adds a trapper for all events from a given event generator.

Note that since timers are not broadcast, they cannot be trapped. Only the EventListener which requested the timer will receive that timer.

Definition at line 210 of file EventRouter.cc.

void EventRouter::addTrapper EventTrapper el,
const EventBase e
 

Note that since timers are not broadcast, they cannot be trapped. Only the EventListener which requested the timer will receive that timer.

Definition at line 201 of file EventRouter.cc.

Referenced by Controller::activate(), addTrapper(), WorldStateVelDaemon::DoStart(), SoundPlay::GotEventTranslatorQueue(), and MMCombo::GotEventTranslatorQueue().

void EventRouter::chkTimers  )  [inline, protected]
 

just for debugging

Definition at line 191 of file EventRouter.h.

void EventRouter::dispTimers  )  [inline, protected]
 

just for debugging

Definition at line 202 of file EventRouter.h.

Referenced by chkTimers().

void EventRouter::doSendBuffer  )  [protected]
 

does the work of clearing the buffer (calls doSendEvent() )

Definition at line 294 of file EventRouter.cc.

Referenced by processEvent(), and processEventBuffer().

void EventRouter::doSendEvent const EventBase e  )  [protected]
 

does the work of sending an event

Be aware this is an O(n^2) where n is the number of listeners for a particular event. This is because after each call to processEvent, the list of listeners could have changed so each listener much be verified before it is sent an event. New listeners won't get the current event, but neither should listeners which have just be removed

Definition at line 319 of file EventRouter.cc.

Referenced by doSendBuffer(), and processEvent().

void EventRouter::forgetListener EventListener el  ) 
 

Deprecated:
use removeListener(EventListener* el) instead deprecated, you should call removeListener(EventListener* el) instead

Definition at line 197 of file EventRouter.cc.

unsigned int EventRouter::getBufferTime  )  [inline]
 

returns the time to wait between buffer clears, see EventRouter::buffertime

Returns:
time to wait between buffer clears
See also:
buffertime

Definition at line 73 of file EventRouter.h.

bool EventRouter::hasListeners const EventBase e  )  [inline]
 

counts both listeners and trappers, so stuff can tell if it even needs to bother generating an event...

Definition at line 96 of file EventRouter.h.

bool EventRouter::hasListeners EventBase::EventGeneratorID_t  egid,
unsigned int  sid,
EventBase::EventTypeID_t  etid
[inline]
 

counts both listeners and trappers, so stuff can tell if it even needs to bother generating an event...

Definition at line 95 of file EventRouter.h.

bool EventRouter::hasListeners EventBase::EventGeneratorID_t  egid,
unsigned int  sid
[inline]
 

counts both listeners and trappers, so stuff can tell if it even needs to bother generating an event...

Definition at line 94 of file EventRouter.h.

bool EventRouter::hasListeners EventBase::EventGeneratorID_t  egid  )  [inline]
 

counts both listeners and trappers, so stuff can tell if it even needs to bother generating an event...

Definition at line 93 of file EventRouter.h.

Referenced by addListener(), addTrapper(), hasListeners(), BallDetectionGenerator::processEvent(), removeListener(), and removeTrapper().

void EventRouter::postEvent EventBase e  )  [inline]
 

recommended to create and post an event using current buffer setting

Definition at line 79 of file EventRouter.h.

void EventRouter::postEvent EventBase::EventGeneratorID_t  egid,
unsigned int  sid,
EventBase::EventTypeID_t  etid,
unsigned int  dur,
const std::string &  n,
float  m
[inline]
 

recommended to create and post an event using current buffer setting

Definition at line 78 of file EventRouter.h.

void EventRouter::postEvent EventBase::EventGeneratorID_t  egid,
unsigned int  sid,
EventBase::EventTypeID_t  etid,
unsigned int  dur
[inline]
 

recommended to create and post an event using current buffer setting

Definition at line 77 of file EventRouter.h.

Referenced by addListener(), addTrapper(), WMitem< T >::announce(), Controller::console_callback(), BallDetectionGenerator::createEvent(), StateNode::DoStart(), StateNode::DoStop(), SoundManager::endPlay(), MMCombo::GotAudio(), MMCombo::GotImage(), SoundManager::Play(), WorldStateVelDaemon::processEvent(), SoundNode::processEvent(), SegmentedColorGenerator::processEvent(), RLEGenerator::processEvent(), RegionGenerator::processEvent(), RawCameraGenerator::processEvent(), PlayMotionSequenceNode< SIZE >::processEvent(), JPEGGenerator::processEvent(), InterleavedYUVGenerator::processEvent(), HeadPointerNode::processEvent(), CDTGenerator::processEvent(), WorldState::read(), SoundManager::ReceivedMsg(), MotionManager::receivedMsg(), removeListener(), MotionManager::removeMotion(), removeTrapper(), MMCombo::RPOPENR_notify(), EventTranslator::sendEvent(), SoundManager::StopPlay(), Controller::takeLine(), WMitem_base::unwatch(), and WMitem_base::watch().

void EventRouter::processEvent const EventBase e  )  [virtual]
 

forces unbuffered - sends event *now*. Will clear the buffer first if needed to ensure proper event ordering

Implements EventListener.

Definition at line 313 of file EventRouter.cc.

Referenced by postEvent(), and processTimers().

void EventRouter::processEventBuffer  ) 
 

clears the event buffer, deletes events as it does so.

Definition at line 290 of file EventRouter.cc.

Referenced by processTimers().

void EventRouter::processTimers  ) 
 

determines if timers need to be posted, and posts them if so.

Call this often to ensure accurate timers. Also, will clear event buffer before sending timer events in order to ensure correct ordering of event reception

Definition at line 12 of file EventRouter.cc.

Referenced by MMCombo::GotAudio(), MMCombo::GotImage(), MMCombo::GotPowerEvent(), and MMCombo::GotSensorFrame().

void EventRouter::removeAllTimers  ) 
 

clears all timers for all listeners

Definition at line 92 of file EventRouter.cc.

Referenced by reset(), and ~EventRouter().

void EventRouter::removeListener EventListener el,
const EventBase e
 

stops sending specified events from the generator to the listener. If a timer is passed it will invoke removeTimer(el, e.getSourceID())

Definition at line 183 of file EventRouter.cc.

void EventRouter::removeListener EventListener el,
EventBase::EventGeneratorID_t  egid,
unsigned int  sid,
EventBase::EventTypeID_t  etid
 

stops sending specified events from the generator to the listener.

Definition at line 169 of file EventRouter.cc.

void EventRouter::removeListener EventListener el,
EventBase::EventGeneratorID_t  egid,
unsigned int  sid
 

stops sending specified events from the generator to the listener.

Definition at line 153 of file EventRouter.cc.

void EventRouter::removeListener EventListener el,
EventBase::EventGeneratorID_t  egid
 

stops sending specified events from the generator to the listener.

Definition at line 140 of file EventRouter.cc.

void EventRouter::removeListener EventListener el  ) 
 

stops sending ALL events to the listener, including timers

Definition at line 136 of file EventRouter.cc.

Referenced by ValueEditControl< T >::activate(), EventLogger::clearSlots(), WalkCalibration::deactivate(), PostureEditor::deactivate(), LoadPostureControl::deactivate(), BatteryCheckControl::deactivate(), SensorObserverControl::doSelect(), EventLogger::doSelect(), WorldStateVelDaemon::DoStop(), WorldStateSerializerBehavior::DoStop(), WMMonitorBehavior::DoStop(), WalkToTargetMachine::DoStop(), WalkControllerBehavior::DoStop(), VisualTargetTrans::DoStop(), VisualTargetCloseTrans::DoStop(), TimeOutTrans::DoStop(), StareAtPawBehavior2::DoStop(), StareAtPawBehavior::DoStop(), StareAtBallBehavior::DoStop(), SoundTestBehavior::DoStop(), SoundNode::DoStop(), SimpleChaseBallBehavior::DoStop(), SegCamBehavior::DoStop(), RawCamBehavior::DoStop(), PlayMotionSequenceNode< SIZE >::DoStop(), NullTrans::DoStop(), MotionStressTestBehavior::DoStop(), MCRepeater::DoStop(), LookForSoundBehavior::DoStop(), KinematicSampleBehavior2::DoStop(), KinematicSampleBehavior::DoStop(), HeadPointerNode::DoStop(), HeadPointControllerBehavior::DoStop(), HeadLevelBehavior::DoStop(), GroundPlaneBehavior::DoStop(), FreeMemReportControl::DoStop(), FollowHeadBehavior::DoStop(), ExploreMachine::DoStop(), EventTrans::DoStop(), EventGeneratorBase::DoStop(), EStopControllerBehavior::DoStop(), DriveMeBehavior::DoStop(), Controller::DoStop(), CompletionTrans::DoStop(), CompareTrans< T >::DoStop(), ChaseBallBehavior::DoStop(), CameraBehavior::DoStop(), BatteryMonitorBehavior::DoStop(), BanditMachine::WaitNode::DoStop(), AutoGetupBehavior::DoStop(), ASCIIVisionBehavior::DoStop(), AlanBehavior::DoStop(), forgetListener(), PostureEditor::pause(), BatteryCheckControl::pause(), RunSequenceControl< SequenceSize >::processEvent(), PostureEditor::processEvent(), MCRepeater::processEvent(), LoadPostureControl::processEvent(), GroundPlaneBehavior::processEvent(), FollowHeadBehavior::processEvent(), BanditMachine::WaitNode::processEvent(), AutoGetupBehavior::processEvent(), and AlanBehavior::processEvent().

void EventRouter::removeTimer EventListener el,
unsigned int  sid
 

clears any pending timers with source id sid for listener el

Definition at line 83 of file EventRouter.cc.

void EventRouter::removeTimer EventListener el  ) 
 

clears all pending timers for listener el

Definition at line 74 of file EventRouter.cc.

Referenced by addTimer(), DriveMeBehavior::DoStop(), removeListener(), FreeMemReportControl::resetTimerFreq(), WalkControllerBehavior::runCommand(), HeadPointControllerBehavior::runCommand(), and BatteryMonitorBehavior::stopWarning().

void EventRouter::removeTrapper EventTrapper el  ) 
 

stops sending ALL events to the trapper

Definition at line 285 of file EventRouter.cc.

void EventRouter::removeTrapper EventTrapper el,
EventBase::EventGeneratorID_t  egid,
unsigned int  sid,
EventBase::EventTypeID_t  etid
 

stops sending specified events from the generator to the trapper.

Definition at line 275 of file EventRouter.cc.

void EventRouter::removeTrapper EventTrapper el,
EventBase::EventGeneratorID_t  egid,
unsigned int  sid
 

stops sending specified events from the generator to the trapper.

Definition at line 263 of file EventRouter.cc.

void EventRouter::removeTrapper EventTrapper el,
EventBase::EventGeneratorID_t  egid
 

stops sending specified events from the generator to the trapper.

Definition at line 254 of file EventRouter.cc.

void EventRouter::removeTrapper EventTrapper el,
const EventBase e
 

stops sending specified events from the generator to the trapper.

Definition at line 245 of file EventRouter.cc.

Referenced by Controller::deactivate(), and removeTrapper().

void EventRouter::reset  )  [inline]
 

erases all listeners, trappers and timers, resets EventRouter

Definition at line 70 of file EventRouter.h.

Referenced by ~EventRouter().

void EventRouter::setBufferTime unsigned int  t  )  [inline]
 

sets the time to wait between buffer clears, see EventRouter::buffertime

Parameters:
t time to wait between buffer clears
See also:
buffertime

Definition at line 72 of file EventRouter.h.


Member Data Documentation

unsigned int EventRouter::buffertime [protected]
 

The time between clearings of the buffer.

0 will not use the buffer, events are routed upon posting 1 will clear the buffer at next call to processTimers() or processEventBuffer() a larger value will cause a delay of that number of milliseconds since the last clearing

Definition at line 216 of file EventRouter.h.

Referenced by postEvent(), processTimers(), and setBufferTime().

bool EventRouter::doSendBufferLock [protected]
 

in case of recursive calls to processEventBuffer()/doSendBuffer()

Definition at line 214 of file EventRouter.h.

Referenced by doSendBuffer().

std::vector<EventBase*> EventRouter::events [protected]
 

used to store buffered events

Definition at line 213 of file EventRouter.h.

Referenced by doSendBuffer(), postEvent(), processEvent(), and processEventBuffer().

unsigned int EventRouter::lastBufClear [protected]
 

time of last event buffer clear

Definition at line 215 of file EventRouter.h.

Referenced by doSendBuffer(), and processTimers().

EventMapper EventRouter::listeners [protected]
 

A mapping of which EventListener's should receive events.

Definition at line 290 of file EventRouter.h.

Referenced by addListener(), doSendEvent(), hasListeners(), removeListener(), and reset().

std::vector<TimerEntry*> EventRouter::timers [protected]
 

the list of timer entries being maintained, kept sorted by time they go active

Definition at line 188 of file EventRouter.h.

Referenced by addTimer(), chkTimers(), dispTimers(), processTimers(), removeAllTimers(), and removeTimer().

EventMapper EventRouter::trappers [protected]
 

A mapping of which EventTrapper's should get a chance to trap the event.

Definition at line 289 of file EventRouter.h.

Referenced by addTrapper(), doSendEvent(), hasListeners(), removeTrapper(), and reset().


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

Tekkotsu v2.2
Generated Tue Oct 19 14:20:17 2004 by Doxygen 1.3.9.1