SFBAlarm Class Reference

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

#include <SFBAlarm.h>

Public Member Functions

u32 create (SFBAlarmHandler handler)

u32 create (SFBAlarmArgHandler handler, void *arg)

void update (u32 alarmNumber, SFBAlarmHandler handler)

void update (u32 alarmNumber, SFBAlarmArgHandler handler, void *arg)

bool set (u32 alarmNumber, u32 when)

bool cancel (u32 alarmNumber)

u32 currentAlarmNumber ()

int runDueEvents (int maxEvents, u32 deadline)

int runPriorityEvents (int maxEvents, u32 priorityAtLeast)

bool canCreate ()

u32 created ()

bool canAdd ()

bool canRemove ()

u32 count ()

bool inUse (u32 alarmIndex)

u32 getTopTime ()

Get the earliest time in the queue.

int getUsed ()

Detailed Description

Manage "alarm clock"-style settable timers.

Member Function Documentation

u32 SFBAlarm::getTopTime ( ) [inline]

Get the earliest time in the queue.

Only valid when canRemoveEvent() returns true.

The documentation for this class was generated from the following files:

src/include/SFBAlarm.h
src/components/library/SFBAlarm.cpp


Public Member Functions
u32	create (SFBAlarmHandler handler)
u32	create (SFBAlarmArgHandler handler, void *arg)
void	update (u32 alarmNumber, SFBAlarmHandler handler)
void	update (u32 alarmNumber, SFBAlarmArgHandler handler, void *arg)
bool	set (u32 alarmNumber, u32 when)
bool	cancel (u32 alarmNumber)
u32	currentAlarmNumber ()
int	runDueEvents (int maxEvents, u32 deadline)
int	runPriorityEvents (int maxEvents, u32 priorityAtLeast)
bool	canCreate ()
u32	created ()
bool	canAdd ()
bool	canRemove ()
u32	count ()
bool	inUse (u32 alarmIndex)
u32	getTopTime ()
	Get the earliest time in the queue.
int	getUsed ()