amxd_dm.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_DM_H__)
#define __AMXD_DM_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <amxd/amxd_types.h>
 
amxd_status_t amxd_dm_new(amxd_dm_t** dm);
 
void amxd_dm_delete(amxd_dm_t** dm);
 
amxd_status_t amxd_dm_init(amxd_dm_t* dm);
 
void amxd_dm_clean(amxd_dm_t* dm);
 
amxd_status_t amxd_dm_store_mib(amxd_dm_t* const dm,
                                amxd_object_t* const object);
 
amxd_object_t* amxd_dm_get_mib(amxd_dm_t* const dm,
                               const char* name);
 
amxd_status_t amxd_dm_add_root_object(amxd_dm_t* const dm,
                                      amxd_object_t* const object);
 
amxd_status_t amxd_dm_remove_root_object(amxd_dm_t* const dm, const char* name);
 
amxd_object_t* amxd_dm_get_root(amxd_dm_t* const dm);
 
amxd_object_t* amxd_dm_get_object(amxd_dm_t* const dm, const char* name);
 
amxd_object_t* amxd_dm_findf(amxd_dm_t* const dm,
                             const char* abs_path,
                             ...) __attribute__ ((format(printf, 2, 3)));
 
amxd_status_t amxd_dm_resolve_pathf(amxd_dm_t* const dm,
                                    amxc_llist_t* paths,
                                    const char* abs_path,
                                    ...)  __attribute__ ((format(printf, 3, 4)));
 
amxd_status_t amxd_dm_resolve_pathf_ext(amxd_dm_t* const dm,
                                        bool* key_path,
                                        amxc_llist_t* paths,
                                        const char* abs_path,
                                        ...) __attribute__ ((format(printf, 4, 5)));
const char* amxd_dm_signal_get_path(amxd_dm_t* const dm,
                                    const amxc_var_t* const signal_data);
 
amxd_object_t* amxd_dm_signal_get_object(amxd_dm_t* const dm,
                                         const amxc_var_t* const signal_data);
 
amxd_status_t amxd_dm_invoke_action(amxd_object_t* object,
                                    amxd_param_t* param,
                                    amxd_action_t reason,
                                    const amxc_var_t* const args,
                                    amxc_var_t* const retval);
static inline
amxd_status_t amxd_dm_get_status(amxd_dm_t* dm) {
    return dm == NULL ? amxd_status_invalid_arg : dm->status;
}
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXD_DM_H__