Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

EventRouter::TimerEntry Struct Reference

Contains all the information needed to maintain a timer by the EventRouter. More...

#include <EventRouter.h>


Detailed Description

Contains all the information needed to maintain a timer by the EventRouter.

Definition at line 384 of file EventRouter.h.

List of all members.

Public Member Functions

 TimerEntry (unsigned int nxt)
 constructs an entry using the given value for next - useful for with TimerEntryPtrCmp
 TimerEntry (EventListener *e, size_t s, unsigned int d, bool r)
 constructs with the given values, sets next field automatically; see next
 TimerEntry (const TimerEntry &t)
 just does the default, i'm just being explicit since there's a pointer (no deep copy!)
TimerEntryoperator= (const TimerEntry &t)
 just does the default, i'm just being explicit since there's a pointer (no deep copy!)
void Set (unsigned int d, bool r)
 will reset timer

Public Attributes

EventListenerel
 the listener to fire at
size_t sid
 the source id to fire with
unsigned int delay
 the delay until firing
unsigned int next
 the time at which this timer will go off next
bool repeat
 if true, will reset after firing, else will be deleted

Constructor & Destructor Documentation

EventRouter::TimerEntry::TimerEntry ( unsigned int  nxt  )  [explicit]

constructs an entry using the given value for next - useful for with TimerEntryPtrCmp

Definition at line 386 of file EventRouter.h.

EventRouter::TimerEntry::TimerEntry ( EventListener e,
size_t  s,
unsigned int  d,
bool  r 
)

constructs with the given values, sets next field automatically; see next

Definition at line 388 of file EventRouter.h.

EventRouter::TimerEntry::TimerEntry ( const TimerEntry t  ) 

just does the default, i'm just being explicit since there's a pointer (no deep copy!)

Definition at line 390 of file EventRouter.h.


Member Function Documentation

TimerEntry& EventRouter::TimerEntry::operator= ( const TimerEntry t  ) 

just does the default, i'm just being explicit since there's a pointer (no deep copy!)

Definition at line 392 of file EventRouter.h.

void EventRouter::TimerEntry::Set ( unsigned int  d,
bool  r 
)

will reset timer

Parameters:
d the time from now when the timer should go off (in milliseconds)
r true if the timer should automatically repeat

Definition at line 396 of file EventRouter.h.


Member Data Documentation

the delay until firing

Definition at line 399 of file EventRouter.h.

Referenced by operator=(), and Set().

the listener to fire at

Definition at line 397 of file EventRouter.h.

Referenced by operator=().

the time at which this timer will go off next

Definition at line 400 of file EventRouter.h.

Referenced by EventRouter::TimerEntryPtrCmp::operator()(), operator=(), and Set().

if true, will reset after firing, else will be deleted

Definition at line 401 of file EventRouter.h.

Referenced by operator=(), and Set().

the source id to fire with

Definition at line 398 of file EventRouter.h.

Referenced by operator=().


The documentation for this struct was generated from the following file:

Tekkotsu v5.1CVS
Generated Mon May 9 04:59:07 2016 by Doxygen 1.6.3