amxrt.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(__AMXRT_H__)
#define __AMXRT_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <getopt.h>
 
#include <amxc/amxc_macros.h>
#include <amxc/amxc.h>
#include <amxp/amxp.h>
#include <amxd/amxd_dm.h>
#include <amxo/amxo.h>
#include <amxo/amxo_mibs.h>
#include <amxb/amxb.h>
 
#define AMXRT_COPT_URIS "uris"
#define AMXRT_COPT_DATA_URIS "data-uris"
#define AMXRT_COPT_BACKENDS "backends"
#define AMXRT_COPT_AUTO_DETECT "auto-detect"
#define AMXRT_COPT_AUTO_CONNECT "auto-connect"
#define AMXRT_COPT_INCDIRS "include-dirs"
#define AMXRT_COPT_LIBDIRS "import-dirs"
#define AMXRT_COPT_MIBDIRS "mib-dirs"
#define AMXRT_COPT_ODL "ODL"
#define AMXRT_COPT_DAEMON "daemon"
#define AMXRT_COPT_PRIORITY "priority"
#define AMXRT_COPT_PID_FILE "pid-file"
#define AMXRT_COPT_NAME "name"
#define AMXRT_COPT_PREFIX_PATH "prefix"
#define AMXRT_COPT_PLUGIN_DIR "plugin-dir"
#define AMXRT_COPT_CFG_DIR "cfg-dir"
#define AMXRT_COPT_LISTEN "listen"
#define AMXRT_COPT_EVENT "dm-eventing-enabled"
#define AMXRT_COPT_DUMP_CONFIG "dump-config"
#define AMXRT_COPT_DUMP_CAPS "dump-caps"
#define AMXRT_COPT_BACKENDS_DIR "backend-dir"
#define AMXRT_COPT_RW_DATA_PATH "rw_data_path"
#define AMXRT_COPT_STORAGE_DIR "storage-path"
#define AMXRT_COPT_STORAGE_TYPE "storage-type"
#define AMXRT_COPT_ODL_CONFIG "odl"
#define AMXRT_COPT_LOG "log"
#define AMXRT_COPT_REQUIRES "requires"
#define AMXRT_COPT_HANDLE_EVENTS "dm-events-before-start"
#define AMXRT_COPT_SUSPEND "dm-events-suspend-when-requires"
#define AMXRT_COPT_EXT_DIR "extensions-dir"
 
#define AMXRT_COPT_DIRECTORY "odl.directory"
#define AMXRT_COPT_DEFAULTS "odl.dm-defaults"
#define AMXRT_COPT_EVENTS "odl.load-dm-events"
#define AMXRT_COPT_OBJECTS "odl.dm-objects"
#define AMXRT_COPT_LOAD "odl.dm-load"
#define AMXRT_COPT_SAVE "odl.dm-save"
#define AMXRT_COPT_ON_CHANGED "odl.dm-save-on-changed"
#define AMXRT_COPT_DELAY "odl.dm-save-delay"
#define AMXRT_COPT_INIT_DELAY "odl.dm-save-init-delay"
#define AMXRT_COPT_STORAGE "storage-type"
 
typedef int (* amxrt_arg_fn_t) (amxc_var_t* config,
                                int arg_id,
                                const char* value);
 
amxc_var_t* amxrt_get_config(void);
 
amxo_parser_t* amxrt_get_parser(void);
 
amxd_dm_t* amxrt_get_dm(void);
 
void amxrt_new(void);
 
int amxrt(int argc, char* argv[], amxrt_arg_fn_t fn);
 
int amxrt_init(int argc, char* argv[], amxrt_arg_fn_t fn);
 
int amxrt_register_or_wait(void);
 
int amxrt_run(void);
 
void amxrt_stop(void);
 
void amxrt_delete(void);
 
int amxrt_load_odl_files(int argc, char* argv[], int index);
 
int amxrt_connect(void);
 
void amxrt_enable_syssigs(amxc_var_t* syssigs);
 
void amxrt_cmd_line_options_reset(void);
 
int amxrt_cmd_line_add_option(int id, char short_option, const char* long_option, int has_args, const char* doc, const char* arg_doc);
 
void amxrt_cmd_line_set_usage_doc(const char* usage);
 
int amxrt_cmd_line_parse(int argc, char* argv[], amxrt_arg_fn_t fn);
 
void amxrt_cmd_line_parse_assignment(const char* option, bool force);
 
void amxrt_print_usage(void);
 
int amxrt_config_init(int argc, char* argv[], int* index, amxrt_arg_fn_t fn);
 
void amxrt_config_scan_backend_dirs(void);
 
void amxrt_config_read_env_var(const char* var_name, const char* config_name, int32_t var_type);
 
int amxrt_el_create(void);
 
int amxrt_el_start(void);
 
int amxrt_el_stop(void);
 
int amxrt_el_destroy(void);
 
int amxrt_dm_save_load_main(int reason, amxd_dm_t* dm, amxo_parser_t* parser);
 
int amxrt_caps_apply(void);
 
void amxrt_caps_dump(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXRT_H__