amxp_signal.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_SIGNAL_H__)
#define __AMXP_SIGNAL_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <amxc/amxc_variant.h>
 
typedef struct _amxp_signal_mngr {
    amxc_htable_t signals;            
    amxc_lqueue_t signal_queue;       
    amxc_llist_t regexp_slots;        
    amxc_llist_it_t it;               
    bool enabled;                     
    bool deleted;                     
    bool triggered;                   
    bool suspended;                   
} amxp_signal_mngr_t;
 
typedef struct _amxp_signal {
    amxc_htable_it_t hit;                
    amxc_llist_t slots;                  
    const char* name;                    
    amxp_signal_mngr_t* mngr;            
    bool triggered;                      
} amxp_signal_t;
 
typedef void (* amxp_deferred_fn_t) (const amxc_var_t* const data,
                                     void* const priv);
int amxp_sigmngr_new(amxp_signal_mngr_t** sig_mngr);
 
int amxp_sigmngr_delete(amxp_signal_mngr_t** sig_mngr);
 
int amxp_sigmngr_init(amxp_signal_mngr_t* sig_mngr);
 
int amxp_sigmngr_clean(amxp_signal_mngr_t* sig_mngr);
 
int amxp_sigmngr_add_signal(amxp_signal_mngr_t* const sig_mngr,
                            const char* name);
 
int amxp_sigmngr_remove_signal(amxp_signal_mngr_t* const sig_mngr,
                               const char* name);
amxp_signal_t* amxp_sigmngr_find_signal(const amxp_signal_mngr_t* const sig_mngr,
                                        const char* name);
 
void amxp_sigmngr_trigger_signal(amxp_signal_mngr_t* const sig_mngr,
                                 const char* name,
                                 const amxc_var_t* const data);
 
int amxp_sigmngr_emit_signal(const amxp_signal_mngr_t* const sig_mngr,
                             const char* name,
                             const amxc_var_t* const data);
 
int amxp_sigmngr_deferred_call(amxp_signal_mngr_t* const sig_mngr,
                               amxp_deferred_fn_t fn,
                               const amxc_var_t* const data,
                               void* priv);
int amxp_sigmngr_enable(amxp_signal_mngr_t* const sig_mngr,
                        bool enable);
 
int amxp_sigmngr_suspend(amxp_signal_mngr_t* const sig_mngr);
 
int amxp_sigmngr_resume(amxp_signal_mngr_t* const sig_mngr);
 
int amxp_signal_new(amxp_signal_mngr_t* sig_mngr,
                    amxp_signal_t** signal,
                    const char* name);
 
int amxp_signal_delete(amxp_signal_t** signal);
 
void amxp_signal_trigger(amxp_signal_t* const signal,
                         const amxc_var_t* const data);
 
int amxp_signal_emit(const amxp_signal_t* const signal,
                     const amxc_var_t* const data);
 
int amxp_signal_read(void);
 
int amxp_signal_fd(void);
 
int amxp_signal_disconnect_all(amxp_signal_t* const signal);
 
const char* amxp_signal_name(const amxp_signal_t* const signal);
 
bool amxp_signal_has_slots(const amxp_signal_t* const signal);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXP_SIGNAL_H__