#include <alarm.h>

Data Fields
uint32_t	tag
	Should always be set to the value OS_ALARM_TAG. More...

const char *	name
	Name set from OSCreateAlarmEx. More...

OSAlarmCallback	callback
	The callback to execute once the alarm is triggered. More...

uint32_t	group
	Used with OSCancelAlarms for bulk cancellation of alarms. More...

OSTime	nextFire
	The time when the alarm will next be triggered. More...

OSAlarmLink	link
	Link used for when this OSAlarm object is inside an OSAlarmQueue. More...

OSTime	period
	The period between alarm triggers, this is only set for periodic alarms. More...

OSTime	start
	The time the alarm was started. More...

void *	userData
	User data set with OSSetAlarmUserData and retrieved with OSGetAlarmUserData. More...

uint32_t	state
	The current state of the alarm, internal values. More...

OSThreadQueue	threadQueue
	Queue of threads currently waiting for the alarm to trigger with OSWaitAlarm. More...

OSAlarmQueue *	alarmQueue
	The queue that this alarm is currently in. More...

OSContext *	context
	The context the alarm was triggered on. More...

Detailed Description

Definition at line 62 of file alarm.h.

Field Documentation

uint32_t tag

Should always be set to the value OS_ALARM_TAG.

Definition at line 65 of file alarm.h.

const char* name

Name set from OSCreateAlarmEx.

Definition at line 68 of file alarm.h.

The callback to execute once the alarm is triggered.

Definition at line 73 of file alarm.h.

uint32_t group

Used with OSCancelAlarms for bulk cancellation of alarms.

Definition at line 76 of file alarm.h.

OSTime nextFire

The time when the alarm will next be triggered.

Definition at line 81 of file alarm.h.

Link used for when this OSAlarm object is inside an OSAlarmQueue.

Definition at line 84 of file alarm.h.

OSTime period

The period between alarm triggers, this is only set for periodic alarms.

Definition at line 87 of file alarm.h.

The time the alarm was started.

Definition at line 90 of file alarm.h.

void* userData

User data set with OSSetAlarmUserData and retrieved with OSGetAlarmUserData.

Definition at line 93 of file alarm.h.

uint32_t state

The current state of the alarm, internal values.

Definition at line 96 of file alarm.h.

Queue of threads currently waiting for the alarm to trigger with OSWaitAlarm.

Definition at line 99 of file alarm.h.

The queue that this alarm is currently in.

Definition at line 102 of file alarm.h.

The context the alarm was triggered on.

Definition at line 105 of file alarm.h.

The documentation for this struct was generated from the following file: