Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more
Fork of
mbed
by 
mbed official
Timeout Class Reference
A Timeout is used to call a function at a point in the future. More...
#include <Timeout.h>
Inherits mbed::Ticker.
Static Public Member Functions | |
| static void | irq () |
| The handler registered with the underlying timer interrupt. | |
Protected Member Functions | |
| virtual void | handler () |
| The handler called to service the timer event of the derived class. | |
| void | insert (unsigned int timestamp) |
| Insert in to linked list. | |
| void | remove () |
| Remove from linked list, if in it. | |
Static Protected Member Functions | |
| static unsigned int | timestamp () |
| Get the current usec timestamp. | |
Protected Attributes | |
| TimerEvent * | _next |
| Pointer to the next in the list, NULL if last. | |
| unsigned int | _timestamp |
| The timestamp at which the even should be triggered. | |
Static Protected Attributes | |
| static TimerEvent * | _head |
| The head of the list of the events, NULL if none. | |
Detailed Description
A Timeout is used to call a function at a point in the future.
You can use as many seperate Timeout objects as you require.
Example:
// Blink until timeout. #include "mbed.h" Timeout timeout; DigitalOut led(LED1); int on = 1; void attimeout() { on = 0; } int main() { timeout.attach(&attimeout, 5); while(on) { led = !led; wait(0.2); } }
Definition at line 40 of file Timeout.h.
Member Function Documentation
| virtual void handler | ( | ) | [protected, virtual] |
The handler called to service the timer event of the derived class.
Reimplemented from Ticker.
| void insert | ( | unsigned int | timestamp ) | [protected, inherited] |
Insert in to linked list.
| static void irq | ( | ) | [static, inherited] |
The handler registered with the underlying timer interrupt.
| void remove | ( | ) | [protected, inherited] |
Remove from linked list, if in it.
| static unsigned int timestamp | ( | ) | [static, protected, inherited] |
Get the current usec timestamp.
Field Documentation
TimerEvent* _head [static, protected, inherited] |
The head of the list of the events, NULL if none.
Definition at line 46 of file TimerEvent.h.
TimerEvent* _next [protected, inherited] |
Pointer to the next in the list, NULL if last.
Definition at line 50 of file TimerEvent.h.
unsigned int _timestamp [protected, inherited] |
The timestamp at which the even should be triggered.
Definition at line 54 of file TimerEvent.h.
Generated on Tue Jul 12 2022 11:27:31 by
1.7.2