Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
mbed::TimerEvent Class Referenceabstract

#include <TimerEvent.h>

Inheritance diagram for mbed::TimerEvent:
mbed::NonCopyable< TimerEvent > mbed::Ticker mbed::LowPowerTicker mbed::Timeout mbed::LowPowerTimeout

Public Member Functions

 TimerEvent (const ticker_data_t *data)
 
virtual ~TimerEvent ()
 

Static Public Member Functions

static void irq (uint32_t id)
 

Protected Member Functions

virtual void handler ()=0
 
void insert (timestamp_t timestamp)
 
void insert_absolute (us_timestamp_t timestamp)
 
void remove ()
 

Protected Attributes

ticker_event_t event
 
const ticker_data_t_ticker_data
 

Detailed Description

Base abstraction for timer interrupts

Note
Synchronization level: Interrupt safe

Constructor & Destructor Documentation

TimerEvent::~TimerEvent ( )
virtual

Destruction removes it...

Member Function Documentation

void TimerEvent::insert ( timestamp_t  timestamp)
protected

Set relative timestamp of the internal event.

Parameters
timestampevent's us timestamp
Warning
Do not insert more than one timestamp. The same event object is used for every insert/insert_absolute call.
Ticker's present timestamp is used for reference. For timestamps from the past the event is scheduled after ticker's overflow. For reference
See also
convert_timestamp
void TimerEvent::insert_absolute ( us_timestamp_t  timestamp)
protected

Set absolute timestamp of the internal event.

Parameters
timestampevent's us timestamp
Warning
Do not insert more than one timestamp. The same event object is used for every insert/insert_absolute call.
void TimerEvent::irq ( uint32_t  id)
static

The handler registered with the underlying timer interrupt

Parameters
idTimer Event ID
void TimerEvent::remove ( )
protected

Remove timestamp.


The documentation for this class was generated from the following files:
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.