TUKS MCU Introductory course / TUKS-COURSE-THERMOMETER

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.

Fork of TUKS-COURSE-TIMER by TUKS MCU Introductory course

Embed: (wiki syntax)

« Back to documentation index

Timeout Class Reference
Public Member Functions | Static Public Member Functions | Protected Attributes

Timeout Class Reference
[Drivers]

A Timeout is used to call a function at a point in the future. More...

#include <Timeout.h>

Inherits mbed::Ticker.

Public Member Functions

void attach (Callback< void()> func, float t)
 Attach a function to be called by the Ticker, specifiying the interval in seconds.
template<typename T , typename M >
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), t).") void attach(T *obj
 Attach a member function to be called by the Ticker, specifiying the interval in seconds.

Static Public Member Functions

static void irq (uint32_t id)
 The handler registered with the underlying timer interrupt.

Protected Attributes

timestamp_t _delay
 Time delay (in microseconds) for re-setting the multi-shot callback.
Callback< void()> _function
 Callback.

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.

Synchronization level: Interrupt safe

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 55 of file Timeout.h.

Generated on Tue Jul 12 2022 17:39:01 by  doxygen 1.7.2