subscribed_notifications.h

Go to the documentation of this file.

 
#ifndef SYSREPO_SUBSCRIBED_NOTIFICATIONS_H_
#define SYSREPO_SUBSCRIBED_NOTIFICATIONS_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <sys/stat.h>
 
#include "sysrepo.h"
 
typedef enum {
    SRSN_SUB_NOTIF,             
    SRSN_YANG_PUSH_PERIODIC,    
    SRSN_YANG_PUSH_ON_CHANGE    
} srsn_sub_type_t;
 
typedef enum {
    SRSN_YP_CHANGE_INVALID = -1,
    SRSN_YP_CHANGE_CREATE,
    SRSN_YP_CHANGE_DELETE,
    SRSN_YP_CHANGE_INSERT,
    SRSN_YP_CHANGE_MOVE,
    SRSN_YP_CHANGE_REPLACE,
    SRSN_COUNT_YP_CHANGE
} srsn_yp_change_t;
 
typedef struct {
    uint32_t sub_id;
    char *xpath_filter;
    struct timespec stop_time;
    uint32_t sent_count;
    uint32_t excluded_count;
    int suspended;
 
    srsn_sub_type_t type;
 
    union {
        struct {
            char *stream;
            struct timespec start_time;
        } sub_notif;
        struct {
            sr_datastore_t ds;
            uint32_t period;
            struct timespec anchor_time;
        } yp_periodic;
        struct {
            sr_datastore_t ds;
            uint32_t dampening_period;
            int sync_on_start;
            int excluded_change[SRSN_COUNT_YP_CHANGE];
        } yp_on_change;
    };
} srsn_state_sub_t;
 
int srsn_filter_subtree2xpath(const struct lyd_node *subtree, sr_session_ctx_t *session, char **xpath_filter);
 
int srsn_stream_collect_mods(const char *stream, const char *xpath_filter, const struct ly_ctx *ly_ctx,
        struct ly_set **mod_set);
 
int srsn_notif_sent(uint32_t sub_id);
 
int srsn_subscribe(sr_session_ctx_t *session, const char *stream, const char *xpath_filter, const struct timespec *stop_time,
        const struct timespec *start_time, int sub_no_thread, sr_subscription_ctx_t **sub,
        struct timespec *replay_start_time, int *fd, uint32_t *sub_id);
 
int srsn_yang_push_periodic(sr_session_ctx_t *session, sr_datastore_t ds, const char *xpath_filter, uint32_t period_ms,
        const struct timespec *anchor_time, const struct timespec *stop_time, int *fd, uint32_t *sub_id);
 
int srsn_yang_push_on_change(sr_session_ctx_t *session, sr_datastore_t ds, const char *xpath_filter,
        uint32_t dampening_period_ms, int sync_on_start, int excluded_changes[SRSN_COUNT_YP_CHANGE],
        const struct timespec *stop_time, int sub_no_thread, sr_subscription_ctx_t **sub, int *fd, uint32_t *sub_id);
 
int srsn_yang_push_on_change_resync(uint32_t sub_id);
 
int srsn_modify_xpath_filter(uint32_t sub_id, const char *xpath_filter);
 
int srsn_modify_stop_time(uint32_t sub_id, const struct timespec *stop_time);
 
int srsn_yang_push_modify_periodic(uint32_t sub_id, uint32_t period_ms, const struct timespec *anchor_time);
 
int srsn_yang_push_modify_on_change(uint32_t sub_id, uint32_t dampening_period_ms);
 
int srsn_suspend(uint32_t sub_id, const char *reason);
 
int srsn_resume(uint32_t sub_id);
 
int srsn_terminate(uint32_t sub_id, const char *reason);
 
int srsn_oper_data_streams_cb(sr_session_ctx_t *session, uint32_t sub_id, const char *module_name, const char *path,
        const char *request_xpath, uint32_t request_id, struct lyd_node **parent, void *private_data);
 
int srsn_oper_data_subscriptions(srsn_state_sub_t **subs, uint32_t *count);
 
int srsn_oper_data_sub(uint32_t sub_id, srsn_state_sub_t **sub);
 
void srsn_oper_data_subscriptions_free(srsn_state_sub_t *subs, uint32_t count);
 
int srsn_read_notif(int fd, const struct ly_ctx *ly_ctx, struct timespec *timestamp, struct lyd_node **notif);
 
int srsn_read_notif_lyb(int fd, struct timespec *timestamp, char **lyb, uint32_t *lyb_size);
 
int srsn_poll(int fd, uint32_t timeout_ms);
 
typedef void (*srsn_notif_cb)(const struct lyd_node *notif, const struct timespec *timestamp, void *cb_data);
 
int srsn_read_dispatch_init(sr_conn_ctx_t *conn, srsn_notif_cb cb);
 
int srsn_read_dispatch_start(int fd, sr_conn_ctx_t *conn, srsn_notif_cb cb, void *cb_data);
 
int srsn_read_dispatch_add(int fd, void *cb_data);
 
int srsn_read_dispatch_del(int fd);
 
uint32_t srsn_read_dispatch_count(void);
 
int srsn_read_dispatch_destroy(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SYSREPO_SUBSCRIBED_NOTIFICATIONS_H_ */