0.01.00
ot::TimerMilliScheduler Class Reference

This class implements the millisecond timer scheduler. More...

#include <src/core/common/timer.hpp>

Inheritance diagram for ot::TimerMilliScheduler:
ot::TimerScheduler ot::InstanceLocator

Public Member Functions

 TimerMilliScheduler (otInstance &aInstance)
 This constructor initializes the object. More...
 
void Add (TimerMilli &aTimer)
 This method adds a timer instance to the timer scheduler. More...
 
void Remove (TimerMilli &aTimer)
 This method removes a timer instance to the timer scheduler. More...
 
void ProcessTimers (void)
 This method processes the running timers.
 
- Public Member Functions inherited from ot::InstanceLocator
otInstanceGetInstance (void) const
 This method returns a reference to the parent otInstance structure. More...
 
Ip6::Ip6GetIp6 (void) const
 This method returns a reference to the Ip6. More...
 
ThreadNetifGetNetif (void) const
 This method returns a reference to the thread network interface. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ot::TimerScheduler
 TimerScheduler (otInstance &aInstance)
 This constructor initializes the object. More...
 
void Add (Timer &aTimer, const AlarmApi &aAlarmApi)
 This method adds a timer instance to the timer scheduler. More...
 
void Remove (Timer &aTimer, const AlarmApi &aAlarmApi)
 This method removes a timer instance to the timer scheduler. More...
 
void ProcessTimers (const AlarmApi &aAlarmApi)
 This method processes the running timers. More...
 
void SetAlarm (const AlarmApi &aAlarmApi)
 This method sets the platform alarm based on timer at front of the list. More...
 
- Protected Member Functions inherited from ot::InstanceLocator
 InstanceLocator (otInstance &aInstance)
 This constructor initializes the object. More...
 
- Static Protected Member Functions inherited from ot::TimerScheduler
static bool IsStrictlyBefore (uint32_t aTimeA, uint32_t aTimeB)
 This static method compares two times and indicates if the first time is strictly before (earlier) than the second time. More...
 
- Protected Attributes inherited from ot::TimerScheduler
TimermHead
 

Detailed Description

This class implements the millisecond timer scheduler.

Constructor & Destructor Documentation

§ TimerMilliScheduler()

ot::TimerMilliScheduler::TimerMilliScheduler ( otInstance aInstance)
inline

This constructor initializes the object.

Parameters
[in]aInstanceA reference to the instance object.

Member Function Documentation

§ Add()

void ot::TimerMilliScheduler::Add ( TimerMilli aTimer)
inline

This method adds a timer instance to the timer scheduler.

Parameters
[in]aTimerA reference to the timer instance.

§ Remove()

void ot::TimerMilliScheduler::Remove ( TimerMilli aTimer)
inline

This method removes a timer instance to the timer scheduler.

Parameters
[in]aTimerA reference to the timer instance.

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