SFBAlarm.h File Reference

Support for time-based events. More...

#include "SFBTypes.h"
#include "SFBWiring.h"

Include dependency graph for SFBAlarm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

class  SFBAlarm
 Manage "alarm clock"-style settable timers. More...

Defines

#define SFBALARM_QUEUE_SIZE   51
 The maximum number of alarms.

Typedefs

typedef void(* SFBAlarmHandler )(u32 when)
 A function pointer type that can be called when an alarm is triggered.
typedef void(* SFBAlarmArgHandler )(u32 when, void *arg)
 A function pointer type that can be called when an alarm is triggered.
typedef u8 SFBAlarmIndexType
 grows (at least) as (14 bytes * SFBALARM_QUEUE_SIZE).

Variables

SFBAlarm Alarms
 The object controlling all SFBAlarm functions.


Detailed Description

Support for time-based events.

Author:
David H. Ackley.
Date:
(C) 2009 All rights reserved.
Code License:
The GNU Lesser General Public License
License Note:
All code samples shown in documentation are placed into the public domain.

Define Documentation

#define SFBALARM_QUEUE_SIZE   51

The maximum number of alarms.

The RAM footprint of an SFBAlarm


Typedef Documentation

typedef void(* SFBAlarmArgHandler)(u32 when, void *arg)

A function pointer type that can be called when an alarm is triggered.

This is the more powerful of the such funtion pointer types; see SFBAlarmArgHandler for the more limited type.

typedef void(* SFBAlarmHandler)(u32 when)

A function pointer type that can be called when an alarm is triggered.

This is the simpler of the such funtion pointer types; see SFBAlarmArgHandler for the more complicated type.

grows (at least) as (14 bytes * SFBALARM_QUEUE_SIZE).

The type of an alarm index. u8 suffices unless SFBALARM_QUEUE_SIZE exceeds 255


Generated on Fri Apr 22 06:54:35 2011 for SFB by doxygen 1.5.9