Massimiliano Flori / mbed_fw_rev1_1

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.

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

Timeout Class Reference
Public Member Functions | Static Public Member Functions

Timeout Class Reference

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

#include <Timeout.h>

Inherits mbed::Ticker.

Public Member Functions

pFunctionPointer_t attach (void(*fptr)(void), float t)
 Attach a function to be called by the Ticker, specifiying the interval in seconds.
template<typename T >
pFunctionPointer_t attach (T *tptr, void(T::*mptr)(void), float t)
 Attach a member function to be called by the Ticker, specifiying the interval in seconds.
pFunctionPointer_t add_function (void(*fptr)(void))
 Add a function to be called by the Ticker at the end of the call chain.
template<typename T >
pFunctionPointer_t add_function (T *tptr, void(T::*mptr)(void))
 Add a function to be called by the Ticker at the end of the call chain.
pFunctionPointer_t add_function_front (void(*fptr)(void))
 Add a function to be called by the Ticker at the beginning of the call chain.
template<typename T >
pFunctionPointer_t add_function_front (T *tptr, void(T::*mptr)(void))
 Add a function to be called by the Ticker at the beginning of the call chain.
pFunctionPointer_t attach_us (void(*fptr)(void), unsigned int t)
 Attach a function to be called by the Ticker, specifiying the interval in micro-seconds.
template<typename T >
pFunctionPointer_t attach_us (T *tptr, void(T::*mptr)(void), unsigned int t)
 Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds.
void detach ()
 Detach the function.
bool remove_function (pFunctionPointer_t pf)
 Remove a function from the Ticker's call chain.

Static Public Member Functions

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

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

Member Function Documentation

pFunctionPointer_t add_function ( void(*)(void)  fptr ) [inherited]

Add a function to be called by the Ticker at the end of the call chain.

Parameters:
fptrthe function to add
Returns:
The function object created for 'fptr'

Definition at line 81 of file Ticker.h.

pFunctionPointer_t add_function ( T *  tptr,
void(T::*)(void)  mptr 
) [inherited]

Add a function to be called by the Ticker at the end of the call chain.

Parameters:
tptrpointer to the object to call the member function on
mptrpointer to the member function to be called
Returns:
The function object created for 'tptr' and 'mptr'

Definition at line 119 of file Ticker.h.

pFunctionPointer_t add_function_front ( void(*)(void)  fptr ) [inherited]

Add a function to be called by the Ticker at the beginning of the call chain.

Parameters:
fptrthe function to add
Returns:
The function object created for 'fptr'

Definition at line 92 of file Ticker.h.

pFunctionPointer_t add_function_front ( T *  tptr,
void(T::*)(void)  mptr 
) [inherited]

Add a function to be called by the Ticker at the beginning of the call chain.

Parameters:
tptrpointer to the object to call the member function on
mptrpointer to the member function to be called
Returns:
The function object created for 'tptr' and 'mptr'

Definition at line 132 of file Ticker.h.

pFunctionPointer_t attach ( void(*)(void)  fptr,
float  t 
) [inherited]

Attach a function to be called by the Ticker, specifiying the interval in seconds.

Parameters:
fptrpointer to the function to be called
tthe time between calls in seconds
Returns:
The function object created for 'fptr'

Definition at line 70 of file Ticker.h.

pFunctionPointer_t attach ( T *  tptr,
void(T::*)(void)  mptr,
float  t 
) [inherited]

Attach a member function to be called by the Ticker, specifiying the interval in seconds.

Parameters:
tptrpointer to the object to call the member function on
mptrpointer to the member function to be called
tthe time between calls in seconds
Returns:
The function object created for 'tptr' and 'mptr'

Definition at line 106 of file Ticker.h.

pFunctionPointer_t attach_us ( void(*)(void)  fptr,
unsigned int  t 
) [inherited]

Attach a function to be called by the Ticker, specifiying the interval in micro-seconds.

Parameters:
fptrpointer to the function to be called
tthe time between calls in micro-seconds
Returns:
The function object created for 'fptr'

Definition at line 144 of file Ticker.h.

pFunctionPointer_t attach_us ( T *  tptr,
void(T::*)(void)  mptr,
unsigned int  t 
) [inherited]

Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds.

Parameters:
tptrpointer to the object to call the member function on
mptrpointer to the member function to be called
tthe time between calls in micro-seconds
Returns:
The function object created for 'tptr' and 'mptr'

Definition at line 161 of file Ticker.h.

void detach (  ) [inherited]

Detach the function.

static void irq ( uint32_t  id ) [static, inherited]

The handler registered with the underlying timer interrupt.

bool remove_function ( pFunctionPointer_t  pf ) [inherited]

Remove a function from the Ticker's call chain.

Parameters:
pfthe function object to remove
Returns:
true if the function was found and removed, false otherwise

Definition at line 179 of file Ticker.h.

Generated on Thu Jul 14 2022 04:58:45 by  doxygen 1.7.2