amxd_object_event.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(__AMXD_OBJECT_EVENT_H__)
#define __AMXD_OBJECT_EVENT_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <amxd/amxd_types.h>
 
void amxd_object_send_signal(amxd_object_t* const object,
                             const char* name,
                             amxc_var_t* const data,
                             bool trigger);
 
AMXD_INLINE
void amxd_object_emit_signal(amxd_object_t* const object,
                             const char* name,
                             amxc_var_t* const data) {
    amxd_object_send_signal(object, name, data, false);
}
 
AMXD_INLINE
void amxd_object_trigger_signal(amxd_object_t* const object,
                                const char* name,
                                amxc_var_t* const data) {
    amxd_object_send_signal(object, name, data, true);
}
 
void amxd_object_send_add_inst(amxd_object_t* instance, bool trigger);
 
AMXD_INLINE
void amxd_object_emit_add_inst(amxd_object_t* instance) {
    amxd_object_send_add_inst(instance, false);
}
 
AMXD_INLINE
void amxd_object_trigger_add_inst(amxd_object_t* instance) {
    amxd_object_send_add_inst(instance, true);
}
 
void amxd_object_send_del_object(amxd_object_t* object, bool trigger);
 
void amxd_object_send_del_inst(amxd_object_t* instance, bool trigger);
AMXD_INLINE
void amxd_object_emit_del_inst(amxd_object_t* instance) {
    amxd_object_send_del_object(instance, false);
}
 
AMXD_INLINE
void amxd_object_trigger_del_inst(amxd_object_t* instance) {
    amxd_object_send_del_object(instance, true);
}
 
void amxd_object_send_changed(amxd_object_t* object,
                              amxc_var_t* params,
                              bool trigger);
 
AMXD_INLINE
void amxd_object_emit_changed(amxd_object_t* object,
                              amxc_var_t* params) {
    amxd_object_send_changed(object, params, false);
}
 
AMXD_INLINE
void amxd_object_trigger_changed(amxd_object_t* object,
                                 amxc_var_t* params) {
    amxd_object_send_changed(object, params, true);
}
 
amxd_status_t amxd_object_new_pi(amxd_object_t* object,
                                 uint32_t sec);
 
amxd_status_t amxd_object_delete_pi(amxd_object_t* object);
 
amxd_status_t amxd_object_describe_events(amxd_object_t* const object,
                                          amxc_var_t* const value,
                                          amxd_dm_access_t access);
 
amxd_status_t amxd_object_add_event_ext(amxd_object_t* const object,
                                        const char* event_name,
                                        amxc_var_t* event_data);
 
amxd_status_t amxd_object_add_event(amxd_object_t* const object,
                                    const char* event_name);
 
void amxd_object_remove_event(amxd_object_t* const object,
                              const char* event_name);
 
amxc_var_t* amxd_object_new_event_data(const amxd_object_t* object,
                                       const char* event_name);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXD_OBJECT_EVENT_H__