Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

EventRouter::TimerEntry Struct Reference

#include <EventRouter.h>

List of all members.


Detailed Description

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

Definition at line 353 of file EventRouter.h.


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  )  [inline, explicit]

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

Definition at line 355 of file EventRouter.h.

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

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

Definition at line 357 of file EventRouter.h.

EventRouter::TimerEntry::TimerEntry ( const TimerEntry t  )  [inline]

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

Definition at line 359 of file EventRouter.h.


Member Function Documentation

TimerEntry& EventRouter::TimerEntry::operator= ( const TimerEntry t  )  [inline]

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

Definition at line 361 of file EventRouter.h.

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

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


Member Data Documentation

the listener to fire at

Definition at line 366 of file EventRouter.h.

Referenced by operator=().

the source id to fire with

Definition at line 367 of file EventRouter.h.

Referenced by operator=().

the delay until firing

Definition at line 368 of file EventRouter.h.

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

the time at which this timer will go off next

Definition at line 369 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 370 of file EventRouter.h.

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


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

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