amxb_operators.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_OPERATORS_H__)
#define __AMXB_OPERATORS_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <amxb/amxb_types.h>
 
 
#define AMXB_FLAG_PARAMETERS    0x0001
#define AMXB_FLAG_FUNCTIONS     0x0002
#define AMXB_FLAG_EVENTS        0x0004
#define AMXB_FLAG_OBJECTS       0x0008
#define AMXB_FLAG_INSTANCES     0x0010
#define AMXB_FLAG_FIRST_LVL     0x0020
#define AMXB_FLAG_NAMED         0x0040
#define AMXB_FLAG_EXISTS        0x0080
#define AMXB_FLAG_TEMPLATE_INFO 0x0100
#define AMXB_FLAG_PARTIAL       0x0200
#define AMXB_FLAG_PROTECTED     0x0400
 
int amxb_call(amxb_bus_ctx_t* const bus_ctx,
              const char* object,
              const char* method,
              amxc_var_t* args,
              amxc_var_t* ret,
              int timeout);
 
amxb_request_t* amxb_async_call(amxb_bus_ctx_t* const bus_ctx,
                                const char* object,
                                const char* method,
                                amxc_var_t* args,
                                amxb_be_done_cb_fn_t done_fn,
                                void* priv);
 
 
int amxb_get(amxb_bus_ctx_t* const bus_ctx,
             const char* object,
             int32_t depth,
             amxc_var_t* ret,
             int timeout);
 
int amxb_get_filtered(amxb_bus_ctx_t* const bus_ctx,
                      const char* object,
                      const char* filter,
                      int32_t depth,
                      amxc_var_t* ret,
                      int timeout);
 
int amxb_get_multiple(amxb_bus_ctx_t* const bus_ctx,
                      amxc_var_t* req_paths,
                      int32_t depth,
                      amxc_var_t* ret,
                      int timeout);
 
int amxb_set(amxb_bus_ctx_t* const bus_ctx,
             const char* object,
             amxc_var_t* values,
             amxc_var_t* ret,
             int timeout);
 
int amxb_set_multiple(amxb_bus_ctx_t* const bus_ctx,
                      uint32_t flags,
                      amxc_var_t* req_paths,
                      amxc_var_t* ret,
                      int timeout);
int amxb_add(amxb_bus_ctx_t* const bus_ctx,
             const char* object,
             uint32_t index,
             const char* name,
             amxc_var_t* values,
             amxc_var_t* ret,
             int timeout);
 
int amxb_del(amxb_bus_ctx_t* const bus_ctx,
             const char* object,
             uint32_t index,
             const char* name,
             amxc_var_t* ret,
             int timeout);
 
int amxb_get_supported(amxb_bus_ctx_t* const bus_ctx,
                       const char* object,
                       uint32_t flags,
                       amxc_var_t* ret,
                       int timeout);
 
int amxb_describe(amxb_bus_ctx_t* const bus_ctx,
                  const char* object,
                  uint32_t flags,
                  amxc_var_t* ret,
                  int timeout);
 
int amxb_list(amxb_bus_ctx_t* const bus_ctx,
              const char* object,
              uint32_t flags,
              amxb_be_cb_fn_t fn,
              void* priv);
 
int amxb_resolve(amxb_bus_ctx_t* bus_ctx,
                 amxd_path_t* obj_path,
                 amxc_var_t* ret_val);
 
int amxb_get_instances(amxb_bus_ctx_t* const bus_ctx,
                       const char* search_path,
                       int32_t depth,
                       amxc_var_t* ret,
                       int timeout);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXB_OPERATORS_H__