agt_push.h

Go to the documentation of this file.

#ifdef WITH_YANG_PUSH
/*
 * Copyright (c) 2019 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_agt_push
#define _H_agt_push
 
/*  FILE: agt_push.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
23-nov-19    abb      Begun
*/
 
#ifndef _H_agt_cfg
#include "agt_cfg.h"
#endif
 
#ifndef _H_agt_not
#include "agt_not.h"
#endif
 
#ifndef _H_rpc
#include "rpc.h"
#endif
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
 
 
/********* agt_push_change_t flags fields *************/
 
#define AGT_PUSH_FL_CREATE   bit0
 
#define AGT_PUSH_FL_DELETE   bit1
 
#define AGT_PUSH_FL_INSERT   bit2
 
#define AGT_PUSH_FL_MOVE     bit3
 
#define AGT_PUSH_FL_REPLACE  bit4
 
#define AGT_PUSH_DEF_INCLUDED_CHANGES 0x1f
 
#define AGT_PUSH_SET_CREATE_FLAG(F) (F) |= AGT_PUSH_FL_CREATE
 
#define AGT_PUSH_GET_CREATE_FLAG(F) ((F) & AGT_PUSH_FL_CREATE)
 
#define AGT_PUSH_SET_DELETE_FLAG(F) (F) |= AGT_PUSH_FL_DELETE
 
#define AGT_PUSH_GET_DELETE_FLAG(F) ((F) & AGT_PUSH_FL_DELETE)
 
#define AGT_PUSH_SET_INSERT_FLAG(F) (F) |= AGT_PUSH_FL_INSERT
 
#define AGT_PUSH_GET_INSERT_FLAG(F) ((F) & AGT_PUSH_FL_INSERT)
 
#define AGT_PUSH_SET_MOVE_FLAG(F) (F) |= AGT_PUSH_FL_MOVE
 
#define AGT_PUSH_GET_MOVE_FLAG(F) ((F) & AGT_PUSH_FL_MOVE)
 
#define AGT_PUSH_SET_REPLACE_FLAG(F) (F) |= AGT_PUSH_FL_REPLACE
 
#define AGT_PUSH_GET_REPLACE_FLAG(F) ((F) & AGT_PUSH_FL_REPLACE)
 
 
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
typedef enum agt_push_dserr_t_ {
    AGT_PUSH_DSERR_NONE,
 
    AGT_PUSH_DSERR_DATASTORE,
 
    AGT_PUSH_DSERR_FILTER_REF,
 
    AGT_PUSH_DSERR_SUBTREE_FILTER,
 
    AGT_PUSH_DSERR_XPATH_FILTER,
 
    AGT_PUSH_DSERR_STOP_TIME,
 
    AGT_PUSH_DSERR_ENCODING,
 
    AGT_PUSH_DSERR_PERIODIC,
 
    AGT_PUSH_DSERR_PERIOD,
 
    AGT_PUSH_DSERR_ANCHOR_TIME,
 
    AGT_PUSH_DSERR_ON_CHANGE,
 
    AGT_PUSH_DSERR_DAMPENING_PERIOD,
 
    AGT_PUSH_DSERR_SYNC_ON_START,
 
    AGT_PUSH_DSERR_EXCLUDED_CHANGE,
 
    AGT_PUSH_DSERR_ID,
} agt_push_dserr_t;
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern status_t
    agt_push_init (obj_template_t *update_obj,
                   obj_template_t *change_obj);
 
 
extern status_t
    agt_push_init2 (void);
 
 
extern void
    agt_push_cleanup (void);
 
 
extern status_t
    agt_push_establish_subscription (
        ses_cb_t *scb,
        ncx_nmda_ds_t datastore_id,
        const xmlChar *selection_filter_ref,
        const val_value_t *datastore_subtree_filter,
        const val_value_t *datastore_xpath_filter,
        const xmlChar *stop_time,
        const val_value_t *encoding,
        const val_value_t *parentval,
        boolean periodic,
        uint32 period,
        const xmlChar *anchor_time,
        boolean on_change,
        uint32 dampening_period,
        boolean sync_on_start,
        uint32 included_changes,
        agt_not_subid_t *subid,
        agt_push_dserr_t *errnum,
        val_value_t **errchild);
 
 
 
extern status_t
    agt_push_modify_subscription (
        ses_cb_t *scb,
        agt_not_subid_t cur_subid,
        ncx_nmda_ds_t datastore_id,
        const xmlChar *selection_filter_ref,
        const val_value_t *datastore_subtree_filter,
        const val_value_t *datastore_xpath_filter,
        const xmlChar *stop_time,
        boolean periodic,
        uint32 period,
        const xmlChar *anchor_time,
        boolean on_change,
        boolean dampening_set,
        uint32 dampening_period,
        const val_value_t *parentval,
        agt_push_dserr_t *errnum,
        val_value_t **errchild);
 
 
#ifdef WITH_YANG_PUSH2
extern status_t
    agt_push_edit_subscription (ses_cb_t *scb,
                                const agt_not_subparms_t *parms,
                                agt_push_dserr_t *errnum);
 
#endif  // WITH_YANG_PUSH2
 
 
extern status_t
    agt_push_sync_subscription (agt_not_subid_t subid);
 
 
extern void
    agt_push_config_update (rpc_msg_t *msg,
                            agt_cfg_transaction_t *txcb);
 
 
 
extern boolean
    agt_push_is_enabled (void);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_push */
#endif      // WITH_YANG_PUSH