agt_not.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2025, 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_not
#define _H_agt_not
/*  FILE: agt_not.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************
 
date             init     comment
----------------------------------------------------------------------
30-may-09    abb      Begun.
*/
 
#include <xmlstring.h>
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_tstamp
#include "tstamp.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_yang_patch
#include "yang_patch.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* header only */
 
 
/********************************************************************
*                                                                   *
*                         C O N S T A N T S                         *
*                                                                   *
*********************************************************************/
 
#define AGT_NOT_MODULE1     (const xmlChar *)"notifications"
 
#define AGT_NOT_MODULE2     (const xmlChar *)"nc-notifications"
 
 
/********************************************************************
*                                                                   *
*                             T Y P E S                             *
*                                                                   *
*********************************************************************/
 
typedef uint32 agt_not_subid_t;
 
 
typedef enum agt_not_subevent_t_ {
    AGT_NOT_SUBEV_NONE,
 
    AGT_NOT_SUBEV_ACTIVE,
 
    AGT_NOT_SUBEV_INACTIVE,
} agt_not_subevent_t;
 
 
typedef struct agt_not_msg_t_ {
    dlq_hdr_t                qhdr;
 
    obj_template_t          *notobj;
 
    dlq_hdr_t                keyQ;
 
    /* payload set by caller: Q of val_value_t */
    dlq_hdr_t                payloadQ;
 
    uint32                   msgid;
 
    xmlChar                  eventTime[TSTAMP_MIN_SIZE];
 
    val_value_t             *msg;
 
    val_value_t             *event;
 
    boolean usemsgid;
 
    status_t res;
 
    val_value_t            *treetop;
 
    ncx_sm_mpid_t          *sm_mpid;
 
} agt_not_msg_t;
 
 
typedef enum agt_not_filtertyp_t_ {
    AGT_NOT_FILTER_NONE,   
    AGT_NOT_FILTER_EMPTY,
 
    AGT_NOT_FILTER_SUBTREE,
 
    AGT_NOT_FILTER_XPATH,
} agt_not_filtertyp_t;
 
 
typedef enum agt_not_sterr_t_ {
    AGT_NOT_STERR_NONE,              
    AGT_NOT_STERR_FILTER_REF,        
    AGT_NOT_STERR_SUBTREE_FILTER,    
    AGT_NOT_STERR_XPATH_FILTER,      
    AGT_NOT_STERR_STREAM,            
    AGT_NOT_STERR_START_TIME,        
    AGT_NOT_STERR_STOP_TIME,         
    AGT_NOT_STERR_ENCODING,          
    AGT_NOT_STERR_ID,                
} agt_not_sterr_t;
 
 
typedef enum agt_not_push_change_t_ {
    AGT_NOT_PUSH_CHANGE_NONE,      
    AGT_NOT_PUSH_CHANGE_CREATE,    
    AGT_NOT_PUSH_CHANGE_DELETE,    
    AGT_NOT_PUSH_CHANGE_INSERT,    
    AGT_NOT_PUSH_CHANGE_MOVE,      
    AGT_NOT_PUSH_CHANGE_REPLACE,   
} agt_not_push_change_t;
 
 
typedef enum agt_not_suspend_reason_t_ {
    AGT_NOT_SUSPEND_NONE,
 
    AGT_NOT_SUSPEND_INSUFFICIENT_RESOURCES,
 
    AGT_NOT_SUSPEND_UNSUPPORTABLE_VOLUME,
 
    AGT_NOT_SUSPEND_PERIOD_UNSUPPORTED,
 
    AGT_NOT_SUSPEND_UPDATE_TOO_BIG,
 
    AGT_NOT_SUSPEND_SYNC_TOO_BIG,
} agt_not_suspend_reason_t;
 
 
typedef enum agt_not_term_reason_t_ {
    AGT_NOT_TERM_NONE,
 
    AGT_NOT_TERM_FILTER_UNAVAILABLE,
 
    AGT_NOT_TERM_NO_SUCH_SUBSCRIPTION,
 
    AGT_NOT_TERM_STREAM_UNAVAILABLE,
 
    AGT_NOT_TERM_SUSPENSION_TIMEOUT,
 
    AGT_NOT_TERM_DATASTORE_NOT_SUBSCRIBABLE,
 
    AGT_NOT_TERM_UNCHANGING_SELECTION,
 
} agt_not_term_reason_t;
 
 
typedef enum agt_not_sub_state_t_ {
    AGT_NOT_SUBST_NONE,
 
    AGT_NOT_SUBST_VALID,
 
    AGT_NOT_SUBST_INVALID,
 
    AGT_NOT_SUBST_CONCLUDED,
} agt_not_sub_state_t;
 
 
typedef enum agt_not_rcvr_state_t_ {
    AGT_NOT_RCVRST_NONE,
 
    AGT_NOT_RCVRST_ACTIVE,
 
    AGT_NOT_RCVRST_SUSPENDED,
 
    AGT_NOT_RCVRST_CONNECTING,
 
    AGT_NOT_RCVRST_DISCONNECTED,
 
} agt_not_rcvr_state_t;
 
typedef void
    (*agt_not_modify_filter_cbfn_t) (ses_cb_t *scb,
                                     agt_not_subid_t subid,
                                     agt_not_filtertyp_t filtyp,
                                     const val_value_t *new_filter);
 
 
typedef void
    (*agt_not_delete_subscription_cbfn_t) (agt_not_subid_t subid,
                                           boolean kill_pending);
 
 
 
typedef void
    (*agt_not_check_push_cbfn_t) (ses_id_t sid);
 
 
typedef void
    (*agt_not_activate_push_cbfn_t) (agt_not_subid_t subid,
                                     ses_id_t sid);
 
 
typedef void
    (*agt_not_module_removed_cbfn_t) (const ncx_module_t *mod);
 
 
 
typedef void
    (*agt_not_stream_cbfn_t) (const xmlChar *event_stream,
                              agt_not_subevent_t subevent,
                              void *cookie);
 
 
 
 
typedef struct agt_not_rcvrparms_t_ {
 
    op_editop_t editop;
 
    boolean is_establish;
 
    const xmlChar *name;
 
    const xmlChar *remote_address;
 
    uint16 remote_port;
 
    boolean remote_port_set;
 
    const xmlChar *local_address;
 
    uint16 local_port;
 
    boolean local_port_set;
 
    boolean enable_segmentation;
 
    boolean enable_segmentation_set;
 
    uint16 max_segment_size;
 
    boolean max_segment_size_set;
 
} agt_not_rcvrparms_t;
 
 
 
typedef struct agt_not_sub_rcvrparms_t_ {
 
    op_editop_t editop;
 
    uint32 id;
 
    const xmlChar *name;
 
    const xmlChar *name_ref;
 
} agt_not_sub_rcvrparms_t;
 
 
 
typedef struct agt_not_sub_modversion_t_ {
 
    op_editop_t editop;
 
    const xmlChar *module_name;
 
    const xmlChar *revision;
 
    const xmlChar *revision_label;
 
} agt_not_sub_modversion_t;
 
 
 
typedef struct agt_not_subparms_t_ {
 
    op_editop_t editop;
 
    boolean is_establish;
 
    agt_not_subid_t id;
 
    const xmlChar *filter_name;
 
    const val_value_t *subtree_filter;
 
    const val_value_t *xpath_filter;
 
    const val_value_t *encoding;
 
    const val_value_t *transport;
 
    const xmlChar *source_address;
 
    const xmlChar *purpose;
 
    const val_value_t *parentval;
 
    uint8 dscp;
 
    const xmlChar *stream;
 
    //const xmlChar *replay_start_time;
 
    const xmlChar *stop_time;
 
    boolean configured_replay;
 
    boolean is_datastore;
 
    ncx_nmda_ds_t datastore_id;
 
    boolean is_periodic;
 
    boolean period_set;
 
    uint32 period;
 
    const xmlChar *anchor_time;
 
    boolean on_change;
 
    boolean sync_on_start;
 
    uint32 included_changes;
 
    boolean delete_rcvrs_pending;
 
} agt_not_subparms_t;
 
 
typedef struct agt_not_substats_t_ {
 
    uint64 out_events;
 
    uint64 excluded_events;
 
    xmlChar replay_start_time[TSTAMP_MIN_SIZE];
 
    agt_not_sub_state_t  sub_state;
 
} agt_not_substats_t;
 
 
 
typedef struct agt_not_rcvrstats_t_ {
 
    uint64 out_events;
 
    uint64 excluded_events;
 
    agt_not_rcvr_state_t  rcvr_state;
 
} agt_not_rcvrstats_t;
 
 
/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/
 
 
extern status_t
    agt_not_init (void);
 
 
extern status_t
    agt_not_init_sil_sa (void);
 
 
extern status_t
    agt_not_init2 (void);
 
 
extern void
    agt_not_cleanup (void);
 
 
extern void
    agt_not_cleanup_sil_sa (void);
 
 
 
#ifdef PTHREADS
extern uint32
    agt_not_send_notifications (thd_tcb_t *tcb);
 
#else
 
extern uint32
    agt_not_send_notifications (void);
 
#endif // PTHREADS
 
 
/*
* @brief Remove any delivered notifications when the replay buffer
* size is set to zero
*
* Called from periodic task or thread
*
* Cleanup is now done internally and this function is removed
*
* extern void
*    agt_not_clean_eventlog (void);
*/
 
 
extern void
    agt_not_remove_subscription (ses_id_t sid);
 
 
extern agt_not_msg_t *
    agt_not_new_notification (obj_template_t *eventType);
 
 
extern agt_not_msg_t *
    agt_not_new_notification_ex (obj_template_t *eventType,
                                 const xmlChar *eventTime);
 
 
extern void
    agt_not_free_notification (agt_not_msg_t *notif);
 
 
extern void
    agt_not_add_to_payload (agt_not_msg_t *notif,
                val_value_t *val);
 
 
 
extern void
    agt_not_add_key (agt_not_msg_t *notif,
                     val_value_t *val);
 
 
extern void
    agt_not_queue_notification (agt_not_msg_t *notif);
 
 
extern void
    agt_not_queue_notification_stream (const xmlChar *stream_name,
                                       agt_not_msg_t *notif);
 
 
extern boolean
    agt_not_is_replay_event (const obj_template_t *notifobj);
 
 
extern void
    agt_not_cancel_subscription (ses_id_t sid);
 
 
extern status_t
    agt_not_start_subscription (ses_cb_t *scb,
                                const xmlChar *stream,
                                xmlChar *startTime,
                                xmlChar *stopTime,
                                boolean futurestop,
                                op_filtertyp_t  filtertype,
                                val_value_t *filterval,
                                val_value_t *selectval);
 
 
 
extern status_t
    agt_not_start_subscription2 (ses_cb_t *scb,
                                 const xmlChar *stream,
                                 xmlChar *startTime,
                                 xmlChar *stopTime,
                                 boolean futurestop,
                                 op_filtertyp_t  filtertype,
                                 val_value_t *filterval,
                                 val_value_t *selectval,
                                 ncx_msg_encoding_t out_encoding);
 
 
extern status_t
    agt_not_start_subscription_rfc8650 (ses_cb_t *scb,
                                        uint32 id);
 
 
 
 
#ifdef WITH_YP_HA
extern status_t
    agt_not_go_active (void);
#endif  // WITH_YP_HA
 
#ifdef WITH_YP_HA
extern void
    agt_not_go_standby (void);
#endif  // WITH_YP_HA
 
 
#ifdef WITH_YANG_PUSH
extern status_t
    agt_not_init_yangpush (obj_template_t *streams_obj);
#endif  // WITH_YANG_PUSH
 
 
extern status_t
    agt_not_set_filter (const xmlChar *name,
                        ncx_nmda_filtyp_t nmda_filtyp,
                        agt_not_filtertyp_t filtyp,
                        const val_value_t *filval);
 
 
 
extern status_t
    agt_not_clone_filter (ncx_nmda_filtyp_t nmda_filtyp,
                          const xmlChar *name,
                          agt_not_filtertyp_t *filtyp,
                          val_value_t **filval);
 
 
extern status_t
    agt_not_delete_filter (const xmlChar *name,
                           ncx_nmda_filtyp_t nmda_filtyp);
 
 
 
extern status_t
    agt_not_delete_all_filters (boolean force);
 
 
extern status_t
    agt_not_establish_subscription (
        ses_cb_t *scb,
        const xmlChar *stream_filter_name,
        const val_value_t *stream_subtree_filter,
        const val_value_t *stream_xpath_filter,
        const xmlChar *stream,
        const xmlChar *replay_start_time,
        const xmlChar *stop_time,
        const val_value_t *encoding,
        const val_value_t *parentval,
        agt_not_subid_t *subid,
        agt_not_sterr_t *errnum,
        val_value_t **errchild);
 
 
status_t
    agt_not_modify_subscription (
        ses_cb_t *scb,
        agt_not_subid_t subid,
        const xmlChar *stream_filter_name,
        const val_value_t *stream_subtree_filter,
        const val_value_t *stream_xpath_filter,
        const xmlChar *stop_time,
        const val_value_t *parentval,
        agt_not_sterr_t *errnum,
        val_value_t **errchild);
 
 
extern status_t
    agt_not_delete_dynamic_subscription (ses_id_t sid,
                                         agt_not_subid_t subid);
 
 
 
extern status_t
    agt_not_delete_configured_subscription (agt_not_subid_t subid,
                                            boolean silent_kill);
 
 
extern status_t
    agt_not_kill_dynamic_subscription (agt_not_subid_t subid);
 
 
#ifdef WITH_YANG_PUSH
extern status_t
    agt_not_setup_push_subscription (
        ses_cb_t *scb,
        const xmlChar *selection_filter_ref,
        const xmlChar *stop_time,
        const val_value_t *encoding,
        const val_value_t *parentval,
        agt_not_modify_filter_cbfn_t modify_cbfn,
        agt_not_delete_subscription_cbfn_t delete_cbfn,
        agt_not_activate_push_cbfn_t activate_cbfn,
        agt_not_subid_t *subid,
        agt_not_sterr_t *errnum,
        val_value_t **errchild,
        boolean *is_binary,
        boolean *is_restconf);
 
 
extern status_t
    agt_not_modify_push_subscription (
        ses_id_t sid,
        agt_not_subid_t cur_subid,
        const xmlChar *selection_filter_ref,
        const xmlChar *stop_time,
        const val_value_t *parentval,
        agt_not_sterr_t *errnum,
        val_value_t **errchild);
 
 
extern status_t
    agt_not_register_yang_push (agt_not_check_push_cbfn_t cbfn,
                                agt_not_module_removed_cbfn_t mod_cbfn);
 
 
extern status_t
    agt_not_register_notif_objs (obj_template_t *replay_completed,
                                 obj_template_t *subscription_completed,
                                 obj_template_t *subscription_modified,
                                 obj_template_t *subscription_resumed,
                                 obj_template_t *subscription_started,
                                 obj_template_t *subscription_suspended,
                                 obj_template_t *subscription_terminated);
 
 
extern status_t
    agt_not_send_periodic_update(agt_not_subid_t subid,
                                 ses_id_t sid,
                                 obj_template_t *notif_obj,
                                 rpc_msg_t *msg,
                                 boolean *subscription_deleted);
 
 
extern status_t
    agt_not_get_simop_update(agt_not_subid_t subid,
                             ses_id_t sid,
                             const xmlChar *filespec,
                             rpc_msg_t *msg,
                             boolean first_push,
                             obj_template_t *notif_obj,
                             boolean *subscription_deleted,
                             uint32 *checksum,
                             uint32 *bytecnt);
 
 
extern status_t
    agt_not_send_simop_update(agt_not_subid_t subid,
                              ses_id_t sid,
                              const xmlChar *filespec,
                              rpc_msg_t *msg,
                              obj_template_t *notif_obj,
                              boolean *subscription_deleted);
 
 
extern void
    agt_not_suspend_push_subscription (agt_not_subid_t subid,
                                       agt_not_suspend_reason_t reason);
 
 
 
extern void
    agt_not_resume_push_subscription (agt_not_subid_t subid);
 
 
extern void
    agt_not_kill_push_subscription (agt_not_subid_t subid,
                                    agt_not_term_reason_t term_reason);
 
 
extern status_t
    agt_not_send_onchange_update(agt_not_subid_t subid,
                                 ses_id_t sid,
                                 obj_template_t *notif_obj,
                                 yang_patch_cb_t *pcb,
                                 boolean *subscription_deleted);
 
 
#endif // WITH_YANG_PUSH
 
 
extern void
    agt_not_remove_module_filters (const ncx_module_t *mod);
 
 
#ifdef WITH_YANG_PUSH
extern obj_template_t *
    agt_not_get_modified_obj (void);
 
 
extern obj_template_t *
    agt_not_get_started_obj (void);
 
 
extern status_t
    agt_not_send_push_notif (agt_not_subid_t subid,
                             agt_not_msg_t *notif);
 
#endif  // WITH_YANG_PUSH
 
 
extern status_t
    agt_not_create_event_stream (const xmlChar *name,
                                 uint32 eventlog_size,
                                 const xmlChar *description);
 
 
extern status_t
    agt_not_delete_event_stream (ses_cb_t *scb,
                                 const xmlChar *name);
 
 
extern status_t
    agt_not_delete_all_event_streams (ses_cb_t *scb);
 
 
 
extern status_t
    agt_not_edit_module_map (const xmlChar *modname,
                             const xmlChar *stream_name,
                             boolean is_create);
 
 
extern status_t
    agt_not_delete_module_map (const xmlChar *modname);
 
 
 
extern status_t
    agt_not_delete_all_module_maps (ses_cb_t *scb);
 
extern boolean
    agt_not_event_stream_exists (const xmlChar *stream_name);
 
 
extern status_t
    agt_not_clear_event_stream_log (const xmlChar *stream_name);
 
 
 
extern status_t
    agt_not_register_stream_cbfn (const xmlChar *modname,
                                  const xmlChar *stream_name,
                                  boolean all_streams,
                                  agt_not_stream_cbfn_t cbfn,
                                  void *cookie);
 
 
extern void
    agt_not_unregister_stream_cbfn (const xmlChar *modname,
                                    agt_not_stream_cbfn_t cbfn);
 
 
 
 
#ifdef WITH_YCONTROL
extern status_t
    agt_not_register_stream_cbfn_subsys (const xmlChar *subsys_id,
                                         const xmlChar *modname,
                                         const xmlChar *stream_name,
                                         boolean all_streams);
 
 
extern void
    agt_not_unregister_stream_cbfn_subsys (const xmlChar *subsys_id,
                                           const xmlChar *modname);
 
 
 
 
extern status_t
    agt_not_check_register_add (const xmlChar *modname,
                                val_value_t *request_val);
 
 
extern boolean
    agt_not_any_unregistered (const xmlChar *modname);
 
 
 
extern void
    agt_not_subsys_gone (const xmlChar *subsys_id);
 
 
extern status_t
    agt_not_stream_callback_subsys (const xmlChar *stream_name,
                                    agt_not_subevent_t subevent,
                                    const xmlChar *modname,
                                    boolean all_streams);
 
 
#endif   // WITH_YCONTROL
 
 
 
extern void
    agt_not_unload_module (const xmlChar *modname);
 
 
 
extern status_t
    agt_not_set_notif_mpid (agt_not_msg_t *msg,
                            const ncx_sm_mpid_t *mpid);
 
 
#ifdef WITH_RESTCONF
extern status_t
    agt_not_init_restconf_streams (val_value_t *streamsval,
                                   obj_template_t *streamobj);
 
#endif  // WITH_RESTCONF
 
 
#if defined(WITH_YANG_PUSH) && defined(WITH_YANG_PUSH2)
extern status_t
    agt_not_sub_receiver_edit (const agt_not_sub_rcvrparms_t *parms);
 
 
 
extern status_t
    agt_not_delete_sub_receivers (uint32 id);
 
 
extern status_t
    agt_not_edit_subscription (const agt_not_subparms_t *parms,
                               agt_not_sterr_t *errnum,
                               val_value_t **errchild);
 
 
extern status_t
    agt_not_delete_subscriptions (void);
 
 
extern status_t
    agt_not_get_substats (agt_not_subid_t id,
                          agt_not_substats_t *retstats);
 
 
 
extern const xmlChar *
    agt_not_get_sub_state (agt_not_sub_state_t state);
 
 
extern status_t
    agt_not_delete_receivers (void);
 
 
extern status_t
    agt_not_edit_receiver (const agt_not_rcvrparms_t *parms);
 
 
extern status_t
    agt_not_delete_receiver (const xmlChar *name);
 
 
 
extern status_t
    agt_not_get_rcvrstats (agt_not_subid_t id,
                           const xmlChar *rcvr_name,
                           agt_not_rcvrstats_t *retstats);
 
 
extern status_t
    agt_not_reset_rcvr (agt_not_subid_t id,
                        const xmlChar *rcvr_name);
 
 
 
 
extern const xmlChar *
    agt_not_get_rcvr_state (agt_not_rcvr_state_t state);
 
 
 
extern boolean
    agt_not_subid_ok (agt_not_subid_t id);
 
 
extern boolean
    agt_not_subid_in_use (agt_not_subid_t id);
 
 
extern status_t
    agt_not_get_publisher_ids (uint32 subid,
                               const uint32 **retarr,
                               uint32 *retcount);
 
 
#endif   // YANG_PUSH and YANG_PUSH2
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif            /* _H_agt_not */