alarm.h File Reference

#include <wut.h>
#include "threadqueue.h"
#include "time.h"
#include "context.h"

Include dependency graph for alarm.h:

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

Go to the source code of this file.

Data Structures
struct	OSAlarmQueue
struct	OSAlarmLink
struct	OSAlarm

Macros
#define	OS_ALARM_QUEUE_TAG   0x614C6D51u
#define	OS_ALARM_TAG   0x614C724Du

Typedefs
typedef struct OSAlarm	OSAlarm
typedef struct OSAlarmLink	OSAlarmLink
typedef struct OSAlarmQueue	OSAlarmQueue
typedef void(*	OSAlarmCallback) (OSAlarm *, OSContext *)

Functions
BOOL	OSCancelAlarm (OSAlarm *alarm)
	Cancel an alarm.
void	OSCancelAlarms (uint32_t group)
	Cancel all alarms which have a matching tag set by OSSetAlarmTag.
void	OSCreateAlarm (OSAlarm *alarm)
	Initialise an alarm structure.
void	OSCreateAlarmEx (OSAlarm *alarm, const char *name)
	Initialise an alarm structure with a name.
void *	OSGetAlarmUserData (OSAlarm *alarm)
	Return user data set by OSSetAlarmUserData.
void	OSInitAlarmQueue (OSAlarmQueue *queue)
	Initialise an alarm queue structure.
void	OSInitAlarmQueueEx (OSAlarmQueue *queue, const char *name)
	Initialise an alarm queue structure with a name.
BOOL	OSSetAlarm (OSAlarm *alarm, OSTime time, OSAlarmCallback callback)
	Set a one shot alarm to perform a callback after a set amount of time.
BOOL	OSSetPeriodicAlarm (OSAlarm *alarm, OSTime start, OSTime interval, OSAlarmCallback callback)
	Set a repeated alarm to execute a callback every interval from start.
void	OSSetAlarmTag (OSAlarm *alarm, uint32_t group)
	Set an alarm tag which is used in OSCancelAlarms for bulk cancellation.
void	OSSetAlarmUserData (OSAlarm *alarm, void *data)
	Set alarm user data which is returned by OSGetAlarmUserData.
BOOL	OSWaitAlarm (OSAlarm *alarm)
	Sleep the current thread until the alarm has been triggered or cancelled.