amxb_be_mngr.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(__AMXB_BE_MNGR_H__)
#define __AMXB_BE_MNGR_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <amxb/amxb_types.h>
 
//----------------------------------------------------------------
// backend management
int amxb_be_register(amxb_be_funcs_t* const funcs);
 
int amxb_be_unregister(amxb_be_funcs_t* const funcs);
 
amxb_be_funcs_t* amxb_be_find(const char* name);
 
const amxb_be_info_t* amxb_be_get_info(const char* name);
 
int amxb_be_load(const char* path_name);
 
int amxb_be_load_multiple(amxc_var_t* const bes);
 
int amxb_be_remove(const char* backend_name);
 
void amxb_be_remove_all(void);
 
amxc_array_t* amxb_be_list(void);
 
int amxb_be_for_all_connections(amxb_be_task_fn_t fn,
                                const amxc_var_t* args,
                                void* priv);
 
int amxb_be_for_all_listeners(amxb_be_task_fn_t fn,
                              const amxc_var_t* args,
                              void* priv);
amxb_bus_ctx_t* amxb_be_who_has(const char* object_path);
 
void amxb_be_cache_remove_ctx(amxb_bus_ctx_t* ctx);
 
void amxb_be_cache_remove_path(const char* object_path);
 
void amxb_be_cache_set_size(uint32_t size);
 
int amxb_set_config(amxc_var_t* const configuration);
 
//----------------------------------------------------------------
// version (verification) functions
int amxb_check_version(const amxb_version_t* be_version);
 
 
int amxb_check_be_versions(const amxb_version_t* min,
                           const amxb_version_t* max);
 
 
const amxb_version_t* amxb_get_version(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXB_BE_MNGR_H__