Main Page | Modules | Namespace List | Class Hierarchy | Data Structures | Directories | File List | Namespace Members | Data Fields | Globals

alarmmgr.h File Reference


Detailed Description

File public header for the ALP Alarm Manager APIs.

#include <glib.h>
#include <hiker/types.h>
#include <hiker/sysclass.h>

Go to the source code of this file.

Errors

#define ALP_STATUS_ALARM_NO_MEMORY   (ALP_CLASS_ALARM | 0x00010000)
 Unable to allocation memory to complete function call.
#define ALP_STATUS_ALARM_BAD_PARAM   (ALP_CLASS_ALARM | 0x00020000)
 Supplied application ID is invalid, either being NULL or exceeding ALP_ALARM_MAX_APPID_SIZE or requested alarm time has already passed.
#define ALP_STATUS_ALARM_IPC   (ALP_CLASS_ALARM | 0x00030000)
 IPC error occurred during function call.

Defines

#define ALP_ALARM_MAX_APPID_SIZE   64
 Maximum size of an application ID.

Functions

alp_status_t alp_alm_set_alarm (const gchar *appID, guint32 ref, guint32 alarmSeconds)
 Set or cancel an alarm for the given application.
alp_status_t alp_alm_get_alarm (const gchar *appID, guint32 ref, guint32 *alarmSeconds)
 Return the current setting for an alarm.


Define Documentation

#define ALP_STATUS_ALARM_BAD_PARAM   (ALP_CLASS_ALARM | 0x00020000)
 

Supplied application ID is invalid, either being NULL or exceeding ALP_ALARM_MAX_APPID_SIZE or requested alarm time has already passed.

#define ALP_STATUS_ALARM_IPC   (ALP_CLASS_ALARM | 0x00030000)
 

IPC error occurred during function call.

#define ALP_STATUS_ALARM_NO_MEMORY   (ALP_CLASS_ALARM | 0x00010000)
 

Unable to allocation memory to complete function call.


Function Documentation

alp_status_t alp_alm_get_alarm const gchar *  appID,
guint32  ref,
guint32 *  alarmSeconds
 

Return the current setting for an alarm.

Returns the date and time in seconds since 01/01/1970 UTC for the given application ID and alarm reference number.

Parameters:
[in] appID Package name of the calling application.
[in] ref Caller-defined value.
[out] alarmSeconds The date and time the alarm will trigger, given in seconds since 01/01/1970 UTC; if no alarm is active for the application, 0 is returned for the alarm seconds.
Returns:
error code

alp_status_t alp_alm_set_alarm const gchar *  appID,
guint32  ref,
guint32  alarmSeconds
 

Set or cancel an alarm for the given application.

Parameters:
[in] appID Package name of the calling application.
[in] ref Caller-defined value.
[in] alarmSeconds Specifies the date/time in seconds since 01/01/1970 UTC at which the alarm will be triggered, or 0 to cancel the alarm specified by ref if any
Returns:
error code


Generated on Sat Dec 16 20:29:48 2006 for hiker-0.9 by  doxygen 1.4.4