amxs_sync_ctx.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(__AMXS_SYNC_CTX_H__)
#define __AMXS_SYNC_CTX_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <amxs/amxs_types.h>
 
amxs_status_t amxs_sync_ctx_new(amxs_sync_ctx_t** ctx,
                                const char* object_a,
                                const char* object_b,
                                int attributes);
void amxs_sync_ctx_delete(amxs_sync_ctx_t** ctx);
 
amxs_status_t amxs_sync_ctx_init(amxs_sync_ctx_t* ctx,
                                 const char* object_a,
                                 const char* object_b,
                                 int attributes);
 
void amxs_sync_ctx_clean(amxs_sync_ctx_t* ctx);
 
amxs_status_t amxs_sync_ctx_copy(amxs_sync_ctx_t** dest, amxs_sync_ctx_t* src, void* priv);
 
amxs_status_t amxs_sync_ctx_start_sync(amxs_sync_ctx_t* ctx);
 
void amxs_sync_ctx_stop_sync(amxs_sync_ctx_t* ctx);
 
static inline
bool amxs_sync_ctx_is_started(const amxs_sync_ctx_t* const ctx) {
    return ctx == NULL? false:!amxc_llist_is_empty(&ctx->subscriptions);
}
 
 
amxs_status_t amxs_sync_ctx_set_paths(amxs_sync_ctx_t* const ctx,
                                      const char* object_a,
                                      const char* object_b);
 
amxs_status_t amxs_sync_ctx_add_param(amxs_sync_ctx_t* ctx, amxs_sync_param_t* param);
 
amxs_status_t amxs_sync_ctx_add_new_param(amxs_sync_ctx_t* ctx,
                                          const char* param_a,
                                          const char* param_b,
                                          int attributes,
                                          amxs_translation_cb_t translation_cb,
                                          amxs_action_cb_t action_cb,
                                          void* priv);
 
amxs_status_t amxs_sync_ctx_add_new_copy_param(amxs_sync_ctx_t* ctx,
                                               const char* param_a,
                                               const char* param_b,
                                               int attributes);
 
amxs_status_t amxs_sync_ctx_add_object(amxs_sync_ctx_t* ctx, amxs_sync_object_t* object);
 
amxs_status_t amxs_sync_ctx_add_new_object(amxs_sync_ctx_t* ctx,
                                           const char* object_a,
                                           const char* object_b,
                                           int attributes,
                                           amxs_translation_cb_t translation_cb,
                                           amxs_action_cb_t action_cb,
                                           void* priv);
 
amxs_status_t amxs_sync_ctx_add_new_copy_object(amxs_sync_ctx_t* ctx,
                                                const char* object_a,
                                                const char* object_b,
                                                int attributes);
amxs_status_t amxs_sync_ctx_set_local_dm(amxs_sync_ctx_t* ctx,
                                         amxd_dm_t* dm_a,
                                         amxd_dm_t* dm_b);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXS_SYNC_CTX_H__