Components/Libraries/XF/FreeRTOS/TimerManager
From UIT
(Difference between revisions)
Sara.chalokh (Talk | contribs) (Created page with "{{TOC right}} = Timer Manager = This class manage all events delay. This class use the pattern singleton to work = Member Attributes = = Member Functions Documentation = == Ti...") |
Sara.chalokh (Talk | contribs) (→Member Attributes) |
||
(6 intermediate revisions by one user not shown) | |||
Line 3: | Line 3: | ||
This class manage all events delay. This class use the pattern singleton to work | This class manage all events delay. This class use the pattern singleton to work | ||
= Member Attributes = | = Member Attributes = | ||
+ | TimerManager* '''_pInstance''' : the instance of the timer manager | ||
+ | |||
= Member Functions Documentation = | = Member Functions Documentation = | ||
== TimerManager* getInstance() [static] == | == TimerManager* getInstance() [static] == | ||
Line 13: | Line 15: | ||
Call addTimer to create an new Event delay for the given event | Call addTimer to create an new Event delay for the given event | ||
=== Parameters === | === Parameters === | ||
− | opEv : the event that need a delay | + | Event '''opEv''' : the event that need a delay |
+ | |||
== TimerManager() == | == TimerManager() == | ||
=== Description === | === Description === | ||
Line 21: | Line 24: | ||
Create an new Event delay for the given event | Create an new Event delay for the given event | ||
=== Parameters === | === Parameters === | ||
− | opEv : the event that need a delay | + | Event '''opEv''' : the event that need a delay |
+ | |||
== void timerTimeout(EventDelay* oTimeout) == | == void timerTimeout(EventDelay* oTimeout) == | ||
=== Description === | === Description === | ||
This function is called by an EventDelay when it expire | This function is called by an EventDelay when it expire | ||
=== Parameters === | === Parameters === | ||
− | oTimeout : the EventDelay that timeout | + | Event '''oTimeout''' : the EventDelay that timeout |
+ | |||
== void notifyThread(EventDelay* oTimeout) == | == void notifyThread(EventDelay* oTimeout) == | ||
=== Description === | === Description === | ||
Inform the Thread that the delay of an event ends | Inform the Thread that the delay of an event ends | ||
=== Parameters === | === Parameters === | ||
− | oTimeout : the EventDelay that timeout | + | Event '''oTimeout''' : the EventDelay that timeout |
Latest revision as of 20:18, 24 August 2017
|
Timer Manager
This class manage all events delay. This class use the pattern singleton to work
Member Attributes
TimerManager* _pInstance : the instance of the timer manager
Member Functions Documentation
TimerManager* getInstance() [static]
Description
Returns the instance of the timer manager
~TimerManager() [virtual]
Description
The destructor of the TimerManager
void scheduleTimeout(Event* opEv)
Call addTimer to create an new Event delay for the given event
Parameters
Event opEv : the event that need a delay
TimerManager()
Description
The constructor of the Event delay. This constructor is private to respect the singleton pattern
void addTimer(Event* opEv)
Description
Create an new Event delay for the given event
Parameters
Event opEv : the event that need a delay
void timerTimeout(EventDelay* oTimeout)
Description
This function is called by an EventDelay when it expire
Parameters
Event oTimeout : the EventDelay that timeout
void notifyThread(EventDelay* oTimeout)
Description
Inform the Thread that the delay of an event ends
Parameters
Event oTimeout : the EventDelay that timeout