amxp_cron.h

Go to the documentation of this file.

/****************************************************************************
**
** SPDX-License-Identifier: BSD-2-Clause-Patent
**
** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
**
** Redistribution and use in source and binary forms, with or without modification,
** are permitted provided that the following conditions are met:
**
** 1. Redistributions of source code must retain the above copyright notice,
** this list of conditions and the following disclaimer.
**
** 2. Redistributions in binary form must reproduce the above copyright notice,
** this list of conditions and the following disclaimer in the documentation
** and/or other materials provided with the distribution.
**
** Subject to the terms and conditions of this license, each copyright holder
** and contributor hereby grants to those receiving rights under this license
** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
** (except for failure to satisfy the conditions of this license) patent license
** to make, have made, use, offer to sell, sell, import, and otherwise transfer
** this software, where such license applies only to those patent claims, already
** acquired or hereafter acquired, licensable by such copyright holder or contributor
** that are necessarily infringed by:
**
** (a) their Contribution(s) (the licensed copyrights of copyright holders and
** non-copyrightable additions of contributors, in source or binary form) alone;
** or
**
** (b) combination of their Contribution(s) with the work of authorship to which
** such Contribution(s) was added by such copyright holder or contributor, if,
** at the time the Contribution is added, such addition causes such combination
** to be necessarily infringed. The patent license shall not apply to any other
** combinations which include the Contribution.
**
** Except as expressly stated above, no rights or licenses from any copyright
** holder or contributor is granted under this license, whether expressly, by
** implication, estoppel or otherwise.
**
** DISCLAIMER
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
** SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
** CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
** USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**
****************************************************************************/
 
#if !defined(__AMXP_CRON_H__)
#define __AMXP_CRON_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdbool.h>
#include <stdint.h>
#include <amxc/amxc_timestamp.h>
 
/* *INDENT-OFF* */
/* *INDENT-ON* */
typedef struct _cron_expr {
    uint8_t seconds[8];        
    uint8_t minutes[8];        
    uint8_t hours[3];          
    uint8_t days_of_week[1];   
    uint8_t days_of_month[4];  
    uint8_t months[2];         
} amxp_cron_expr_t;
 
int amxp_cron_new(amxp_cron_expr_t** cron_expr);
 
void amxp_cron_delete(amxp_cron_expr_t** cron_expr);
 
int amxp_cron_init(amxp_cron_expr_t* cron_expr);
 
void amxp_cron_clean(amxp_cron_expr_t* cron_expr);
 
/* *INDENT-OFF* */
/* *INDENT-ON* */
int amxp_cron_parse_expr(amxp_cron_expr_t* target, const char* expression, const char** error);
 
int amxp_cron_build_weekly(amxp_cron_expr_t* target,
                           const char* time,
                           const char* days_of_week);
 
int amxp_cron_prev(const amxp_cron_expr_t* expr, const amxc_ts_t* ref, amxc_ts_t* next);
 
int amxp_cron_next(const amxp_cron_expr_t* expr, const amxc_ts_t* ref, amxc_ts_t* next);
 
int64_t amxp_cron_time_until_next(const amxp_cron_expr_t* expr, bool local);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXP_CRON_H__