George Roussos / BLE_Temperature

BLE temperature profile using digital DS1820 or analog LM35 sensors

Dependencies:   DS1820

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

void attach (void(*fptr)(void), float t)
 Attach a function to be called by the Ticker, specifiying the interval in seconds.
template<typename T >
void attach (T *tptr, void(T::*mptr)(void), float t)
 Attach a member function to be called by the Ticker, specifiying the interval in seconds.
void 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 >
void 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.

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

void 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

Definition at line 66 of file Ticker.h.

void 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

Definition at line 77 of file Ticker.h.

void 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

Definition at line 86 of file Ticker.h.

void 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

Definition at line 98 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.

Generated on Tue Jul 12 2022 15:07:16 by  doxygen 1.7.2