Alarmd: rpc-retutime.h Source File

00001 /**
00002  * This file is part of alarmd
00003  *
00004  * Contact Person: David Weinehall <david.weinehall@nokia.com>
00005  *
00006  * Copyright (C) 2006 Nokia Corporation
00007  * alarmd and libalarm are free software; you can redistribute them
00008  * and/or modify them under the terms of the GNU Lesser General Public
00009  * License version 2.1 as published by the Free Software Foundation.
00010  *
00011  * alarmd and libalarm are distributed in the hope that they will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014  * Lesser General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU Lesser General Public
00017  * License along with this software; if not, write to the Free
00018  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
00019  * 02110-1301 USA
00020  */
00021 
00022 #ifndef RPC_RETUTIME_H
00023 #define RPC_RETUTIME_H
00024 
00025 #include <sys/time.h>
00026 #include <glib/gtypes.h>
00027 
00028 /**
00029  * SECTION:rpc-retutime
00030  * @short_description: Helpers for communicating with retu time chip.
00031  *
00032  * these functios are used to set and query the alarm state on the retu rtc
00033  * chip by using the retutime binary.
00034  **/
00035 
00036 /**
00037  * retutime_set_alarm_time:
00038  * @alarm_time: The alarm time to set to the retu chip.
00039  *
00040  * Sets the alarm time on the retu chip to the time indicated by @alarm_time.
00041  * Returns: TRUE on success, FALSE on failure.
00042  **/
00043 gboolean retutime_set_alarm_time(time_t alarm_time);
00044 
00045 /**
00046  * retutime_disable_alarm:
00047  *
00048  * Disables the alarm on the retu rtc chip.
00049  * Returns: TRUE on success, FALSE on failure.
00050  **/
00051 gboolean retutime_disable_alarm(void);
00052 
00053 /**
00054  * retutime_ack_alarm:
00055  *
00056  * Resets the "alarm launched" flag on the retu chip.
00057  * Returns: TRUE on success, FALSE on failure.
00058  **/
00059 gboolean retutime_ack_alarm(void);
00060 
00061 /**
00062  * retutime_query_alarm:
00063  *
00064  * Queries the "alarm launched" flag from the retu chip.
00065  * Returns: TRUE if alarm has launched, FALSE if not.
00066  **/
00067 gboolean retutime_query_alarm(void);
00068 
00069 #endif /* RPC_RETUTIME_H */