AlarmTimer.h

00001 /**********************************************************************************************************************
00002  * DISCLAIMER
00003  * This software is supplied by Renesas Electronics Corporation and is only intended for use with Renesas products. No
00004  * other uses are authorized. This software is owned by Renesas Electronics Corporation and is protected under all
00005  * applicable laws, including copyright laws.
00006  * THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
00007  * THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY,
00008  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED. TO THE MAXIMUM
00009  * EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES
00010  * SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR ANY REASON RELATED TO
00011  * THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
00012  * Renesas reserves the right, without notice, to make changes to this software and to discontinue the availability of
00013  * this software. By using this software, you agree to the additional terms and conditions found by accessing the
00014  * following link:
00015  * http://www.renesas.com/disclaimer
00016  *
00017  * Copyright (C) 2019 Renesas Electronics Corporation. All rights reserved.
00018  *********************************************************************************************************************/
00019 /**************************************************************************//**
00020 * @file          AlarmTimer.h
00021 * @brief         AlarmTimer API
00022 ******************************************************************************/
00023 
00024 #ifndef ALARM_TIMER_H
00025 #define ALARM_TIMER_H
00026 
00027 #include "mbed.h"
00028 
00029 /** A class to communicate a AlarmTimer
00030  *
00031  */
00032 class AlarmTimer {
00033 public:
00034 
00035     /** Set alarm interrupt
00036      *
00037      * @param seconds Alarm time
00038      * @return Returns true if the function is successful. Returns false if the function fails.
00039      */
00040     static bool set(time_t seconds);
00041 
00042     /** Attach a function to call when an alarm interrupt occurs
00043      *
00044      * @param func pointer to the function to be called
00045      */
00046     static void attach(Callback<void()> func);
00047 };
00048 #endif