alarm.h

Go to the documentation of this file.

/*
 * Copyright © 2014 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Thomas Voß <thomas.voss@canonical.com>
 */
#ifndef UBUNTU_HARDWARE_ALARM_H_
#define UBUNTU_HARDWARE_ALARM_H_
 
#include <ubuntu/status.h>
#include <ubuntu/visibility.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
    U_HARDWARE_ALARM_TIME_REFERENCE_BOOT, 
    U_HARDWARE_ALARM_TIME_REFERENCE_RTC 
} UbuntuHardwareAlarmTimeReference;
 
typedef UbuntuHardwareAlarmTimeReference UHardwareAlarmTimeReference;
 
typedef enum
{
    U_HARDWARE_ALARM_SLEEP_BEHAVIOR_WAKEUP_DEVICE,
    U_HARDWARE_ALARM_SLEEP_BEHAVIOR_KEEP_DEVICE_ASLEEP
} UbuntuHardwareAlarmSleepBehavior;
 
typedef UbuntuHardwareAlarmSleepBehavior UHardwareAlarmSleepBehavior;
 
typedef struct
{
  UHardwareAlarmTimeReference reference;
  UHardwareAlarmSleepBehavior sleep_behavior;
} UbuntuHardwareAlarmWaitResult;
 
typedef UbuntuHardwareAlarmWaitResult UHardwareAlarmWaitResult;
 
typedef struct UbuntuHardwareAlarm* UHardwareAlarm;
 
UBUNTU_DLL_PUBLIC UHardwareAlarm
u_hardware_alarm_create();
 
UBUNTU_DLL_PUBLIC void
u_hardware_alarm_ref(
    UHardwareAlarm alarm);
 
UBUNTU_DLL_PUBLIC void
u_hardware_alarm_unref(
    UHardwareAlarm alarm);
 
UBUNTU_DLL_PUBLIC UStatus
u_hardware_alarm_get_elapsed_real_time(
    UHardwareAlarm alarm,
    struct timespec *tz);
 
UBUNTU_DLL_PUBLIC UStatus
u_hardware_alarm_set_timezone(
    UHardwareAlarm alarm,
    const struct timezone *tz);
 
UBUNTU_DLL_PUBLIC UStatus
u_hardware_alarm_set_relative_to_with_behavior(
    UHardwareAlarm alarm,
    UHardwareAlarmTimeReference time_reference,
    UHardwareAlarmSleepBehavior behavior,
    const struct timespec *ts);
 
UBUNTU_DLL_PUBLIC UStatus
u_hardware_alarm_wait_for_next_alarm(
    UHardwareAlarm alarm,
    UHardwareAlarmWaitResult *result);
 
#ifdef __cplusplus
}
#endif
 
#endif