amxp_scheduler.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_SCHEDULER_H__)
#define __AMXP_SCHEDULER_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdbool.h>
#include <stdint.h>
 
#include <amxp/amxp_signal.h>
#include <amxp/amxp_slot.h>
#include <amxp/amxp_timer.h>
#include <amxp/amxp_cron.h>
 
#ifndef __AMXC_LLIST_H__
#error "Missing include <amxc/amxc_llist.h>"
#endif
 
#ifndef __AMXC_HTABLE_H__
#error "Missing include <amxc/amxc_htable.h>"
#endif
 
typedef struct _scheduler_item {
    amxp_cron_expr_t cron;      
    amxp_cron_expr_t end_cron;  
    uint32_t duration;          
    bool end_time_is_set;       
    amxc_ts_t next;             
    amxp_timer_t* timer;        
    bool enabled;               
    amxc_llist_it_t lit;        
    amxc_htable_it_t hit;       
} amxp_scheduler_item_t;
 
typedef struct _scheduler {
    amxp_signal_mngr_t sigmngr; 
    bool use_local_time;        
    amxp_timer_t* timer;        
    amxc_htable_t items;        
    amxc_llist_t ordered_items; 
} amxp_scheduler_t;
 
int amxp_scheduler_new(amxp_scheduler_t** scheduler);
 
void amxp_scheduler_delete(amxp_scheduler_t** scheduler);
 
int amxp_scheduler_init(amxp_scheduler_t* scheduler);
 
void amxp_scheduler_clean(amxp_scheduler_t* scheduler);
 
int amxp_scheduler_enable(amxp_scheduler_t* scheduler, bool enable);
 
int amxp_scheduler_use_local_time(amxp_scheduler_t* scheduler, bool use_local_time);
 
int amxp_scheduler_update(amxp_scheduler_t* scheduler);
 
int amxp_scheduler_connect(amxp_scheduler_t* scheduler,
                           const char* id,
                           amxp_slot_fn_t fn,
                           void* priv);
 
int amxp_scheduler_disconnect(amxp_scheduler_t* scheduler, const char* id, amxp_slot_fn_t fn);
 
int amxp_scheduler_set_cron_item(amxp_scheduler_t* scheduler,
                                 const char* id,
                                 const char* cron_expr,
                                 uint32_t duration);
 
int amxp_scheduler_set_cron_begin_end_item(amxp_scheduler_t* scheduler,
                                           const char* id,
                                           const char* cron_begin,
                                           const char* cron_end);
int amxp_scheduler_set_weekly_item(amxp_scheduler_t* scheduler,
                                   const char* id,
                                   const char* time,
                                   const char* days_of_week,
                                   uint32_t duration);
 
int amxp_scheduler_set_weekly_begin_end_item(amxp_scheduler_t* scheduler,
                                             const char* id,
                                             const char* start_time,
                                             const char* end_time,
                                             const char* days_of_week);
 
int amxp_scheduler_remove_item(amxp_scheduler_t* scheduler,
                               const char* id);
 
int amxp_scheduler_enable_item(amxp_scheduler_t* scheduler,
                               const char* id,
                               bool enable);
 
 
amxp_signal_mngr_t* amxp_scheduler_get_sigmngr(amxp_scheduler_t* scheduler);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXP_SCHEDULER_H__