Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

EventRouter Class Reference

#include <EventRouter.h>

Inheritance diagram for EventRouter:

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 instance of EventRouter to both send (post) and receive (subscribe/listen) to events. (except if you are posting from within a MotionCommand, in which case you should use MotionCommand::postEvent() so that it can correctly handle inter-process communication issues under Aperios (the Aibo's OS) -- under a Unix-based OS, this isn't necessary.) Events posted in non-Main processes will be forwarded to Main for processing.

Event processing is a serialized operation, meaning only one event is ever being processed at a time, and by one listener at a time. The EventRouter contains its own thread lock, so if two threads post events at the same time, the EventRouter will handle ensuring mutual exclusion. Listeners are free to spawn their own threads to handle processing or posting events to avoid being dependent on other listeners' processing times. (Note: threads are not available on the Aibo, so listeners which wish to run on the Aibo are stuck with a "cooperative" multitasking model)

The events available for processing are listed in EventBase::EventGeneratorID_t. Each generator ID's documentation specifies how to interpret the source ID field, and whether you can expect events with that generator ID to be of a subclass of EventBase, such as TextMsgEvent or LocomotionEvent. Many generators send plain EventBase instances.

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

  1. "Specific" listeners: any listener which specifies a particular source id. (doesn't matter if they specified type id as well)
    • older listeners get events before more recently added listeners ("FIFO")
  2. "General" listeners: those that subscribe to an entire generator
    • older listeners get events before more recently added listeners ("FIFO")

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

TimerEvents are generally only sent to the generator which requested them. So if EventListener A requests a timer (see addTimer()) with ID 0 at two second intervals, and 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. However, EventListener A can receive B's timers if it specifically wants to, via addListener(). See "Timers" below.

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.

Timers

addTimer() allows you to request an TimerEvent to be sent at some later point in time, possibly on a repeating basis. Timers are specific to the behavior which requests them, and you do not (and usually should not) call addListener() in order to receive a timer event.

There is an important different between addTimer() and addListener(timerEGID,...)! addTimer will "create" the timer, and will send the timer to the listener which created it when the timer expires. This means that as long as the listener in question does not call addListener(timerEGID), it will only receive its own timers. In other words, with this usage there is no confusion with timer cross-talk between listeners, because each listener is only receiving its own timers.

However, if a listener calls addListener(timerEGID), it will begin receiving all timer events from throughout the system. This allows you to have one behavior "eavesdrop" on another's timers. In order to determine which listener requested/created the timer, you can use the TimerEvent::getTarget() value.

So beware that if you call both addTimer() and addListener(foo,timerEGID), 'foo' will get two calls to processEvent() for its own timers, and one call for all other timers, and will have to know to call TimerEvent::getTarget() to distinguish its timers from other listener's timers (if it cares about the difference...)

Timers are sent to the requesting listener before being broadcast -- EventTrappers cannot filter a listener's own timers, but can prevent the timer from being broadcast to other listeners.

Event processing examples:

Posting events: //method A: basic event posting (EventBase instance is sent) erouter->postEvent(EventBase::aiEGID, 1234, EventBase::statusETID);

//method B: specific event instance is posted (have to use this style to post a subclass) TextMsgEvent txt("hello world"); erouter->postEvent(txt); // or can be done in one line: erouter->postEvent(TextMsgEvent("hello world"))

Receiving events:

  //given an EventListener subclass:
  class YourListener : public EventListener {
  public:
    virtual void processEvent(const EventBase& e) {
      std::cout << "Got: " << e.getName() << std::endl;
    }
  };

  YourListener yourList;

  // subscribes it to all EventBase::aiEGID events:
  erouter->addListener(&yourList, EventBase::aiEGID);

  // subscribes only to button activity from the head, but not other buttons:
  erouter->addListener(&yourList, EventBase::buttonEGID, ERS7Info::HeadButOffset);
Typically in a BehaviorBase subclass, you would just specify 'this' instead of '&yourList'.

Timer processing examples:

Requesting/Creating timers:

  YourListener yourList; // (any EventListener subclass)

  // sends a timer with source ID 123 every 5 seconds to yourList:
  erouter->addTimer(&yourList, 123, 5000);

  // sends a timer with ID 456 after 1 second, *no repeat, one time only*
  erouter->addTimer(&yourList, 456, 1000, false);

  // cancels the first timer
  erouter->removeTimer(&yourList, 123);

  // postpone/update the second timer's settings (*doesn't* create two timers with the same ID)
  erouter->addTimer(&yourList, 456, 2500, false);
Again, typically in a BehaviorBase subclass, you would just specify 'this' instead of '&yourList'.

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

Tutorials:

Definition at line 172 of file EventRouter.h.


Remote Event/State code

static const int defaultPort = 2424
std::list< EventProxy * > proxies
std::map< int, RemoteRouter * > rrouters
Socketsck
int nextProxyPort
void addRemoteListener (EventListener *el, int host, EventBase::EventGeneratorID_t egid)
 Request remote events to be sent to this dog, works like the regular addListeners.
void addRemoteListener (EventListener *el, int host, EventBase::EventGeneratorID_t egid, size_t sid)
void addRemoteListener (EventListener *el, int host, const EventBase &e)
void addRemoteListener (EventListener *el, int host, EventBase::EventGeneratorID_t egid, size_t sid, EventBase::EventTypeID_t etid)
void removeRemoteListener (EventListener *el, int host, EventBase::EventGeneratorID_t egid)
 Stop getting remote events from the given dog.
void removeRemoteListener (EventListener *el, int host, EventBase::EventGeneratorID_t egid, size_t sid)
void removeRemoteListener (EventListener *el, int host, const EventBase &e)
void removeRemoteListener (EventListener *el, int host, EventBase::EventGeneratorID_t egid, size_t sid, EventBase::EventTypeID_t etid)
void requestRemoteStateUpdates (int host, RemoteState::StateType type, unsigned int interval=500)
 Request remote state updates from the remote dog, every interval ms.
void stopRemoteStateUpdates (int host, RemoteState::StateType type)
 Stop getting remote state updates.
bool serveRemoteEventRequests ()
 This is called once on startup; it tells the EventRouter to listen for incoming requests.
int processData (char *data, int bytes)
 This handles incomiung connection requests by starting a new EventProxy.
void removeListener (EventListener *el)
 }
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, size_t sid)
 stops sending specified events from the generator to the listener.
void removeListener (EventListener *el, EventBase::EventGeneratorID_t egid, size_t sid, EventBase::EventTypeID_t etid)
 stops sending specified events from the generator to the listener.
void removeListener (EventListener *el, const EventBase &e)
 Uses the generator, source, and type fields of e to remove a listener for that specific tuple.
void remove (EventListener *el)
 stops all events and timers, shorthand for removeListener(el) and removeTimer(el); Note that trappers are separate, removeTrapper() is not called
static std::string intToStringIP (int ip)
 Converts a int representation of an IP to a string.
static int stringToIntIP (std::string ip)
 Converts a string representation of an IP to an int.
RemoteRouterremoteRouterForHost (int host)

Public Member Functions

 EventRouter ()
 Constructs the router.
virtual ~EventRouter ()
 just calls reset and removeAllTimers()
void reset ()
 erases all listeners, trappers and timers, resets EventRouter
Posting/Processing Events
void postEvent (EventBase::EventGeneratorID_t egid, size_t sid, EventBase::EventTypeID_t etid, unsigned int dur=0)
 recommended to create and post an event using current buffer setting
void postEvent (EventBase::EventGeneratorID_t egid, size_t 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) ATTR_deprecated
 deprecated -- pass by reference instead; this version posts the specified event and then deletes it after processing is complete
void postEvent (const EventBase &e)
 posts the specified event, but doesn't delete it at the end -- equivalent to processEvent(e)
void processTimers ()
 determines if timers need to be posted, and posts them if so.
void processEvent (const EventBase &e)
 sends event to its trappers & listeners, but doesn't delete the event at the end (see also postEvent())
EventTranslatorgetForwardingAgent (ProcessID::ProcessID_t proc) const
 returns the forwarding agent for a given process/thread group (see forwards)
void setForwardingAgent (ProcessID::ProcessID_t proc, EventTranslator *trans)
 sets the forwarding agent for a given process/thread group (see forwards)
Listener/Trapper Recall
bool isListeningAny (EventListener *el, EventBase::EventGeneratorID_t egid)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
bool isListeningAny (EventListener *el, EventBase::EventGeneratorID_t egid, size_t sid)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
bool isListeningAll (EventListener *el, EventBase::EventGeneratorID_t egid)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
bool isListeningAll (EventListener *el, EventBase::EventGeneratorID_t egid, size_t sid)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
bool isListening (EventListener *el, EventBase::EventGeneratorID_t egid, size_t sid, EventBase::EventTypeID_t etid)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
bool isListening (EventListener *el, const EventBase &e)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
bool isTrappingAny (EventTrapper *el, EventBase::EventGeneratorID_t egid)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
bool isTrappingAny (EventTrapper *el, EventBase::EventGeneratorID_t egid, size_t sid)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
bool isTrappingAll (EventTrapper *el, EventBase::EventGeneratorID_t egid)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
bool isTrappingAll (EventTrapper *el, EventBase::EventGeneratorID_t egid, size_t sid)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
bool isTrapping (EventTrapper *el, EventBase::EventGeneratorID_t egid, size_t sid, EventBase::EventTypeID_t etid)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
bool isTrapping (EventTrapper *el, const EventBase &e)
 returns true if the specified listener/trapper would receive any events that match the specified criteria
Listener/Trapper Detection
bool hasListeners (EventBase::EventGeneratorID_t egid)
 counts both listeners and trappers, so generators can tell if it even needs to bother generating an event...
bool hasListeners (EventBase::EventGeneratorID_t egid, size_t sid)
 counts both listeners and trappers, so generators can tell if it even needs to bother generating an event...
bool hasListeners (EventBase::EventGeneratorID_t egid, size_t sid, EventBase::EventTypeID_t etid)
 counts both listeners and trappers, so generators can tell if it even needs to bother generating an event...
bool hasListeners (const EventBase &e)
 counts both listeners and trappers, so generators can tell if it even needs to bother generating an event...
Timer Management
void addTimer (EventListener *el, size_t 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; see remove()
void removeTimer (EventListener *el, size_t sid)
 clears any pending timers with source id sid for listener el
void removeTimer (EventListener *el, EventBase &e)
 clears any pending timers with source id matching that of e, but only if e has generator timerEGID
void removeAllTimers ()
 clears all timers for all listeners
unsigned int getNextTimer ()
 returns time of next timer activation
Listener Management
void addListener (EventListener *el, EventBase::EventGeneratorID_t egid)
 Adds a listener for all events from a given event generator.
void addListener (EventListener *el, EventBase::EventGeneratorID_t egid, size_t sid)
 Adds a listener for all types from a specific source and generator.
void addListener (EventListener *el, EventBase::EventGeneratorID_t egid, size_t sid, EventBase::EventTypeID_t etid)
 Adds a listener for a specific source id and type from a given event generator.
void addListener (EventListener *el, const EventBase &e)
 Uses the generator, source, and type fields of e to add a listener for that specific tuple.
Trapper Management
void addTrapper (EventTrapper *el, const EventBase &e)
 Adds a trapper for a specific source id and type from a given event generator.
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, size_t sid)
 Adds a trapper for all types from a specific source and generator.
void addTrapper (EventTrapper *el, EventBase::EventGeneratorID_t egid, size_t 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, size_t sid)
 stops sending specified events from the generator to the trapper.
void removeTrapper (EventTrapper *el, EventBase::EventGeneratorID_t egid, size_t 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 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
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.
std::queue< PostingStatus * > postings
 stores calls to post() currently in progress -- may grow if one postEvent() triggers another; this allows us to finish processing of the original postEvent() before starting the second.
EventTranslatorforwards [ProcessID::NumProcesses]
 This table will be checked on each processEvent to forward the event to some other destination.

Private Member Functions

 EventRouter (const EventRouter &)
 don't call this
EventRouteroperator= (const EventRouter &)
 don't call this

Classes

class  EventMapper
 Does the actual storage of the mapping between EventBase's and the EventListeners/EventTrappers who should receive them. More...
class  PostingStatus
 contains information regarding the progress of posting an event More...
struct  TimerEntry
 Contains all the information needed to maintain a timer by the EventRouter. More...
class  TimerEntryPtrCmp
 Used by STL to sort the timer list in order of activation time. More...

Member Typedef Documentation

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

makes code more readable

Definition at line 381 of file EventRouter.h.


Constructor & Destructor Documentation

EventRouter::EventRouter (  ) 

Constructs the router.

Definition at line 20 of file EventRouter.cc.

EventRouter::~EventRouter (  )  [virtual]

just calls reset and removeAllTimers()

Definition at line 30 of file EventRouter.cc.

EventRouter::EventRouter ( const EventRouter  )  [private]

don't call this


Member Function Documentation

void EventRouter::reset (  )  [inline]

erases all listeners, trappers and timers, resets EventRouter

Definition at line 177 of file EventRouter.h.

Referenced by ~EventRouter().

void EventRouter::postEvent ( EventBase::EventGeneratorID_t  egid,
size_t  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 184 of file EventRouter.h.

void EventRouter::postEvent ( EventBase e  ) 

deprecated -- pass by reference instead; this version posts the specified event and then deletes it after processing is complete

moving to pass by reference instead of pass by pointer to avoid questions about who deletes the event and the event's scope, also keeping the event on the stack is faster by avoiding unnecessary heap operations.

Definition at line 49 of file EventRouter.cc.

void EventRouter::postEvent ( const EventBase e  )  [inline]

posts the specified event, but doesn't delete it at the end -- equivalent to processEvent(e)

Definition at line 190 of file EventRouter.h.

void EventRouter::processTimers (  ) 

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

Call this often to ensure accurate timers.

Todo:
handle recursive calls

Definition at line 52 of file EventRouter.cc.

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

sends event to its trappers & listeners, but doesn't delete the event at the end (see also postEvent())

this posting method is supplied to allow an EventRouter to behave as a listener as well -- the 'routers' really can form a sort of network, if desired. postEvent() is probably a more memnomic interface to use in direct function calls however, so that is the one you should call.

Implements EventListener.

Definition at line 474 of file EventRouter.cc.

Referenced by postEvent().

EventTranslator* EventRouter::getForwardingAgent ( ProcessID::ProcessID_t  proc  )  const [inline]

returns the forwarding agent for a given process/thread group (see forwards)

Definition at line 203 of file EventRouter.h.

void EventRouter::setForwardingAgent ( ProcessID::ProcessID_t  proc,
EventTranslator trans 
)

sets the forwarding agent for a given process/thread group (see forwards)

Definition at line 469 of file EventRouter.cc.

bool EventRouter::isListeningAny ( EventListener el,
EventBase::EventGeneratorID_t  egid 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 212 of file EventRouter.h.

bool EventRouter::isListeningAny ( EventListener el,
EventBase::EventGeneratorID_t  egid,
size_t  sid 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 213 of file EventRouter.h.

bool EventRouter::isListeningAll ( EventListener el,
EventBase::EventGeneratorID_t  egid 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 214 of file EventRouter.h.

bool EventRouter::isListeningAll ( EventListener el,
EventBase::EventGeneratorID_t  egid,
size_t  sid 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 215 of file EventRouter.h.

bool EventRouter::isListening ( EventListener el,
EventBase::EventGeneratorID_t  egid,
size_t  sid,
EventBase::EventTypeID_t  etid 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 216 of file EventRouter.h.

bool EventRouter::isListening ( EventListener el,
const EventBase e 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 217 of file EventRouter.h.

bool EventRouter::isTrappingAny ( EventTrapper el,
EventBase::EventGeneratorID_t  egid 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 218 of file EventRouter.h.

bool EventRouter::isTrappingAny ( EventTrapper el,
EventBase::EventGeneratorID_t  egid,
size_t  sid 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 219 of file EventRouter.h.

bool EventRouter::isTrappingAll ( EventTrapper el,
EventBase::EventGeneratorID_t  egid 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 220 of file EventRouter.h.

bool EventRouter::isTrappingAll ( EventTrapper el,
EventBase::EventGeneratorID_t  egid,
size_t  sid 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 221 of file EventRouter.h.

bool EventRouter::isTrapping ( EventTrapper el,
EventBase::EventGeneratorID_t  egid,
size_t  sid,
EventBase::EventTypeID_t  etid 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 222 of file EventRouter.h.

bool EventRouter::isTrapping ( EventTrapper el,
const EventBase e 
) [inline]

returns true if the specified listener/trapper would receive any events that match the specified criteria

Definition at line 223 of file EventRouter.h.

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

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

Definition at line 237 of file EventRouter.h.

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

bool EventRouter::hasListeners ( EventBase::EventGeneratorID_t  egid,
size_t  sid 
) [inline]

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

Definition at line 238 of file EventRouter.h.

bool EventRouter::hasListeners ( EventBase::EventGeneratorID_t  egid,
size_t  sid,
EventBase::EventTypeID_t  etid 
) [inline]

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

Definition at line 239 of file EventRouter.h.

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

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

Definition at line 240 of file EventRouter.h.

void EventRouter::addTimer ( EventListener el,
size_t  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

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 109 of file EventRouter.cc.

Referenced by addTimer(), NullTrans::DoStart(), ConnectionMadeTrans::DoStart(), EventProxy::handleRemoteRequest(), PostureEditor::processEvent(), BatteryMonitorBehavior::processEvent(), SensorObserverControl::RTViewControl::refresh(), PostureEditor::refresh(), NetworkStatusControl::refresh(), RemoteRouter::RemoteRouter(), TimeOutTrans::resetTimer(), FreeMemReportControl::resetTimerFreq(), WalkControllerBehavior::runCommand(), UPennWalkControllerBehavior::runCommand(), RemoteRouter::sendRemoteRequest(), BatteryMonitorBehavior::startWarning(), and TorqueCalibrate::TakeMeasurementControl::takeInput().

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 248 of file EventRouter.h.

void EventRouter::removeTimer ( EventListener el,
size_t  sid 
)

clears any pending timers with source id sid for listener el

Definition at line 139 of file EventRouter.cc.

void EventRouter::removeTimer ( EventListener el,
EventBase e 
) [inline]

clears any pending timers with source id matching that of e, but only if e has generator timerEGID

Definition at line 253 of file EventRouter.h.

void EventRouter::removeAllTimers (  ) 

clears all timers for all listeners

Definition at line 148 of file EventRouter.cc.

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

unsigned int EventRouter::getNextTimer (  )  [inline]

returns time of next timer activation

Definition at line 255 of file EventRouter.h.

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

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

Definition at line 154 of file EventRouter.cc.

Referenced by WalkCalibration::activate(), TorqueCalibrate::TakeMeasurementControl::activate(), PostureEditor::activate(), BatteryCheckControl::activate(), addRemoteListener(), EventGeneratorBase::addSrcListener(), SensorObserverControl::doSelect(), EventLogger::doSelect(), WorldStateVelDaemon::DoStart(), WorldStateSerializerBehavior::DoStart(), WMMonitorBehavior::DoStart(), WaypointEngineNode< W, mcName, mcDesc >::DoStart(), WalkToTargetNode::DoStart(), VisualTargetTrans::DoStart(), VisualTargetCloseTrans::DoStart(), TimeOutTrans::DoStart(), TextMsgTrans::DoStart(), SoundNode::DoStart(), SignalTrans< T >::DoStart(), SegCamBehavior::DoStart(), RegionCamBehavior::DoStart(), RawCamBehavior::DoStart(), MotionSequenceNode< SIZE >::DoStart(), MicrophoneServer::DoStart(), MCNodeBase::DoStart(), LostTargetTrans::DoStart(), EventTrans::DoStart(), EventGeneratorBase::DoStart(), EStopControllerBehavior::DoStart(), EchoBehavior::DoStart(), DeadReckoningBehavior< ParticleT >::DoStart(), Controller::DoStart(), CompletionTrans::DoStart(), CompareTrans< T >::DoStart(), BatteryMonitorBehavior::DoStart(), AutoGetupBehavior::DoStart(), EventProxy::handleRemoteRequest(), ValueEditControl< T >::pause(), AutoGetupBehavior::processEvent(), CameraStreamBehavior::receiveData(), EventLogger::runCommand(), RunSequenceControl< SequenceSize >::selectedFile(), LoadPostureControl::selectedFile(), EventGeneratorBase::setAutoListen(), and TorqueCalibrate::TakeMeasurementControl::transition().

void EventRouter::addListener ( EventListener el,
EventBase::EventGeneratorID_t  egid,
size_t  sid 
)

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

Definition at line 162 of file EventRouter.cc.

void EventRouter::addListener ( EventListener el,
EventBase::EventGeneratorID_t  egid,
size_t  sid,
EventBase::EventTypeID_t  etid 
)

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

Definition at line 171 of file EventRouter.cc.

void EventRouter::addListener ( EventListener el,
const EventBase e 
)

Uses the generator, source, and type fields of e to add a listener for that specific tuple.

Definition at line 179 of file EventRouter.cc.

std::string EventRouter::intToStringIP ( int  ip  )  [static]

Converts a int representation of an IP to a string.

Definition at line 267 of file EventRouter.cc.

Referenced by RemoteRouter::connect(), RemoteRouter::forwardEvent(), processData(), RemoteEvents::remoteIPString(), remoteRouterForHost(), and EventBase::setName().

int EventRouter::stringToIntIP ( std::string  ip  )  [static]

Converts a string representation of an IP to an int.

Definition at line 274 of file EventRouter.cc.

void EventRouter::addRemoteListener ( EventListener el,
int  host,
EventBase::EventGeneratorID_t  egid 
)

Request remote events to be sent to this dog, works like the regular addListeners.

Definition at line 189 of file EventRouter.cc.

Referenced by addRemoteListener().

void EventRouter::addRemoteListener ( EventListener el,
int  host,
EventBase::EventGeneratorID_t  egid,
size_t  sid 
)

Definition at line 196 of file EventRouter.cc.

void EventRouter::addRemoteListener ( EventListener el,
int  host,
const EventBase e 
)

Definition at line 203 of file EventRouter.cc.

void EventRouter::addRemoteListener ( EventListener el,
int  host,
EventBase::EventGeneratorID_t  egid,
size_t  sid,
EventBase::EventTypeID_t  etid 
)

Definition at line 207 of file EventRouter.cc.

void EventRouter::removeRemoteListener ( EventListener el,
int  host,
EventBase::EventGeneratorID_t  egid 
)

Stop getting remote events from the given dog.

Definition at line 216 of file EventRouter.cc.

Referenced by removeRemoteListener().

void EventRouter::removeRemoteListener ( EventListener el,
int  host,
EventBase::EventGeneratorID_t  egid,
size_t  sid 
)

Definition at line 223 of file EventRouter.cc.

void EventRouter::removeRemoteListener ( EventListener el,
int  host,
const EventBase e 
)

Definition at line 230 of file EventRouter.cc.

void EventRouter::removeRemoteListener ( EventListener el,
int  host,
EventBase::EventGeneratorID_t  egid,
size_t  sid,
EventBase::EventTypeID_t  etid 
)

Definition at line 235 of file EventRouter.cc.

void EventRouter::requestRemoteStateUpdates ( int  host,
RemoteState::StateType  type,
unsigned int  interval = 500 
)

Request remote state updates from the remote dog, every interval ms.

Definition at line 244 of file EventRouter.cc.

void EventRouter::stopRemoteStateUpdates ( int  host,
RemoteState::StateType  type 
)

Stop getting remote state updates.

Definition at line 250 of file EventRouter.cc.

bool EventRouter::serveRemoteEventRequests (  ) 

This is called once on startup; it tells the EventRouter to listen for incoming requests.

Definition at line 296 of file EventRouter.cc.

int EventRouter::processData ( char *  data,
int  bytes 
) [virtual]

This handles incomiung connection requests by starting a new EventProxy.

Implements SocketListener.

Definition at line 306 of file EventRouter.cc.

RemoteRouter & EventRouter::remoteRouterForHost ( int  host  )  [protected]

void EventRouter::removeListener ( EventListener el  ) 

}

stops sending ALL events to the listener -- does not remove pending timers however (may need to call removeTimer(el) as well); see remove()

Definition at line 328 of file EventRouter.cc.

Referenced by ValueEditControl< T >::activate(), EventLogger::clearSlots(), WalkCalibration::deactivate(), PostureEditor::deactivate(), BatteryCheckControl::deactivate(), SensorObserverControl::doSelect(), EventLogger::doSelect(), WorldStateVelDaemon::DoStop(), WorldStateSerializerBehavior::DoStop(), WMMonitorBehavior::DoStop(), WalkToTargetNode::DoStop(), WalkControllerBehavior::DoStop(), VisualTargetTrans::DoStop(), VisualTargetCloseTrans::DoStop(), UPennWalkControllerBehavior::DoStop(), TimeOutTrans::DoStop(), TextMsgTrans::DoStop(), StewartPlatformBehavior::DoStop(), SoundNode::DoStop(), SegCamBehavior::DoStop(), RegionCamBehavior::DoStop(), RawCamBehavior::DoStop(), NullTrans::DoStop(), MotionSequenceNode< SIZE >::DoStop(), MicrophoneServer::DoStop(), MCNodeBase::DoStop(), HeadPointControllerBehavior::DoStop(), FreeMemReportControl::DoStop(), EventTrans::DoStop(), EventGeneratorBase::DoStop(), EStopControllerBehavior::DoStop(), EchoBehavior::DoStop(), Controller::DoStop(), ConnectionMadeTrans::DoStop(), CompletionTrans::DoStop(), CompareTrans< T >::DoStop(), BatteryMonitorBehavior::DoStop(), AutoGetupBehavior::DoStop(), EventProxy::handleRemoteRequest(), BatteryCheckControl::pause(), TorqueCalibrate::TakeMeasurementControl::processEvent(), RunSequenceControl< SequenceSize >::processEvent(), LoadPostureControl::processEvent(), AutoGetupBehavior::processEvent(), CameraStreamBehavior::receiveData(), remove(), removeRemoteListener(), EventGeneratorBase::removeSrcListener(), EventLogger::runCommand(), TorqueCalibrate::TakeMeasurementControl::transition(), BehaviorBase::~BehaviorBase(), LoadPostureControl::~LoadPostureControl(), and RunSequenceControl< SequenceSize >::~RunSequenceControl().

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

stops sending specified events from the generator to the listener.

Definition at line 340 of file EventRouter.cc.

void EventRouter::removeListener ( EventListener el,
EventBase::EventGeneratorID_t  egid,
size_t  sid 
)

stops sending specified events from the generator to the listener.

Definition at line 349 of file EventRouter.cc.

void EventRouter::removeListener ( EventListener el,
EventBase::EventGeneratorID_t  egid,
size_t  sid,
EventBase::EventTypeID_t  etid 
)

stops sending specified events from the generator to the listener.

Definition at line 361 of file EventRouter.cc.

void EventRouter::removeListener ( EventListener el,
const EventBase e 
)

Uses the generator, source, and type fields of e to remove a listener for that specific tuple.

Definition at line 370 of file EventRouter.cc.

void EventRouter::remove ( EventListener el  )  [inline]

stops all events and timers, shorthand for removeListener(el) and removeTimer(el); Note that trappers are separate, removeTrapper() is not called

Definition at line 325 of file EventRouter.h.

Referenced by TorqueCalibrate::TakeMeasurementControl::deactivate(), NetworkStatusControl::deactivate(), BehaviorBase::DoStop(), and NetworkStatusControl::pause().

void EventRouter::addTrapper ( EventTrapper el,
const EventBase e 
)

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

Note that only the broadcasted timers can be trapped. The EventListener which requested the timer will receive that timer before any trapping is done.

Definition at line 380 of file EventRouter.cc.

Referenced by Controller::activate(), addTrapper(), WorldStateVelDaemon::DoStart(), and Controller::takeLine().

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 389 of file EventRouter.cc.

void EventRouter::addTrapper ( EventTrapper el,
EventBase::EventGeneratorID_t  egid,
size_t  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 398 of file EventRouter.cc.

void EventRouter::addTrapper ( EventTrapper el,
EventBase::EventGeneratorID_t  egid,
size_t  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 408 of file EventRouter.cc.

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 418 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 424 of file EventRouter.cc.

Referenced by Controller::deactivate(), WorldStateVelDaemon::DoStop(), removeTrapper(), and Controller::takeLine().

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

stops sending specified events from the generator to the trapper.

Definition at line 433 of file EventRouter.cc.

void EventRouter::removeTrapper ( EventTrapper el,
EventBase::EventGeneratorID_t  egid,
size_t  sid 
)

stops sending specified events from the generator to the trapper.

Definition at line 442 of file EventRouter.cc.

void EventRouter::removeTrapper ( EventTrapper el,
EventBase::EventGeneratorID_t  egid,
size_t  sid,
EventBase::EventTypeID_t  etid 
)

stops sending specified events from the generator to the trapper.

Definition at line 454 of file EventRouter.cc.

void EventRouter::removeTrapper ( EventTrapper el  ) 

stops sending ALL events to the trapper

Definition at line 464 of file EventRouter.cc.

void EventRouter::chkTimers (  )  [inline, protected]

just for debugging

Definition at line 385 of file EventRouter.h.

void EventRouter::dispTimers (  )  [inline, protected]

just for debugging

Definition at line 396 of file EventRouter.h.

Referenced by chkTimers().

EventRouter& EventRouter::operator= ( const EventRouter  )  [private]

don't call this


Member Data Documentation

const int EventRouter::defaultPort = 2424 [static]

Definition at line 300 of file EventRouter.h.

Referenced by RemoteRouter::RemoteRouter(), and serveRemoteEventRequests().

std::list<EventProxy *> EventRouter::proxies [protected]

Definition at line 306 of file EventRouter.h.

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

std::map<int, RemoteRouter *> EventRouter::rrouters [protected]

Definition at line 308 of file EventRouter.h.

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

Socket* EventRouter::sck [protected]

Definition at line 309 of file EventRouter.h.

Referenced by processData(), and serveRemoteEventRequests().

int EventRouter::nextProxyPort [protected]

Definition at line 310 of file EventRouter.h.

Referenced by processData().

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

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

Definition at line 382 of file EventRouter.h.

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

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

Definition at line 489 of file EventRouter.h.

Referenced by addTrapper(), hasListeners(), isTrapping(), isTrappingAll(), isTrappingAny(), processEvent(), removeTrapper(), and reset().

A mapping of which EventListener's should receive events.

Definition at line 490 of file EventRouter.h.

Referenced by addListener(), hasListeners(), isListening(), isListeningAll(), isListeningAny(), processEvent(), removeListener(), and reset().

std::queue<PostingStatus*> EventRouter::postings [protected]

stores calls to post() currently in progress -- may grow if one postEvent() triggers another; this allows us to finish processing of the original postEvent() before starting the second.

Definition at line 511 of file EventRouter.h.

Referenced by processEvent().

EventTranslator* EventRouter::forwards[ProcessID::NumProcesses] [protected]

This table will be checked on each processEvent to forward the event to some other destination.

The main reason for including this functionality is in the uni-process model, we don't want event postings from real time processes like Motion to block on the event queue processing. So with this mechanism we can intercept those events, and queue them in a separate IPC mechanism to be picked up by Main later on.

This might also be handy for other purposes, such as remote event forwarding over the network...

If the EventTranslator's trapEvent returns true, then further processing on the event is skipped. (see EventTranslator::setTrapEventValue() )

Definition at line 523 of file EventRouter.h.

Referenced by EventRouter(), getForwardingAgent(), processEvent(), setForwardingAgent(), and ~EventRouter().


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

Tekkotsu v4.0
Generated Thu Nov 22 00:58:20 2007 by Doxygen 1.5.4