sysrepo_types.h

Go to the documentation of this file.

#ifndef _SYSREPO_TYPES_H
#define _SYSREPO_TYPES_H

#include <fcntl.h>
#include <inttypes.h>
#include <stddef.h>
#include <sys/stat.h>

struct lyd_node;
struct timespec;

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    SR_ERR_OK = 0,             
    SR_ERR_INVAL_ARG,          
    SR_ERR_LY,                 
    SR_ERR_SYS,                
    SR_ERR_NO_MEMORY,          
    SR_ERR_NOT_FOUND,          
    SR_ERR_EXISTS,             
    SR_ERR_INTERNAL,           
    SR_ERR_UNSUPPORTED,        
    SR_ERR_VALIDATION_FAILED,  
    SR_ERR_OPERATION_FAILED,   
    SR_ERR_UNAUTHORIZED,       
    SR_ERR_LOCKED,             
    SR_ERR_TIME_OUT,           
    SR_ERR_CALLBACK_FAILED,    
    SR_ERR_CALLBACK_SHELVE     
} sr_error_t;

typedef enum {
    SR_LL_NONE = 0,  
    SR_LL_ERR,       
    SR_LL_WRN,       
    SR_LL_INF,       
    SR_LL_DBG        
} sr_log_level_t;

typedef void (*sr_log_cb)(sr_log_level_t level, const char *message);

typedef struct sr_conn_ctx_s sr_conn_ctx_t;

typedef uint32_t sr_cid_t;

typedef struct sr_session_ctx_s sr_session_ctx_t;

typedef enum {
    SR_CONN_DEFAULT = 0x0,              
    SR_CONN_CACHE_RUNNING = 0x1,        
    SR_CONN_CTX_SET_PRIV_PARSED = 0x2   
} sr_conn_flag_t;

typedef uint32_t sr_conn_options_t;

typedef enum {
    SR_DS_STARTUP = 0,     
    SR_DS_RUNNING = 1,     
    SR_DS_CANDIDATE = 2,   
    SR_DS_OPERATIONAL = 3, 
    SR_DS_FACTORY_DEFAULT = 4   
} sr_datastore_t;

#define SR_DS_COUNT 4

#define SR_DS_READ_COUNT 5

#define SR_MOD_DS_NOTIF 5

#define SR_MOD_DS_PLUGIN_COUNT 6

typedef struct {
    const char *plugin_name[SR_MOD_DS_PLUGIN_COUNT];    
} sr_module_ds_t;

typedef struct {
    sr_error_t err_code;    
    char *message;          
    char *error_format;     
    void *error_data;       
} sr_error_info_err_t;

typedef struct {
    sr_error_info_err_t *err;   
    uint32_t err_count;         
} sr_error_info_t;

typedef struct {
    const char *schema_path;        
    const char **features;          
    sr_module_ds_t module_ds;       
    const char *owner;              
    const char *group;              
    mode_t perm;                    
} sr_install_mod_t;

typedef struct {
    const sr_conn_ctx_t *conn;

    struct lyd_node *tree;
} sr_data_t;

typedef enum {
    /* special types that does not contain any data */
    SR_UNKNOWN_T,              
    SR_LIST_T,                 
    SR_CONTAINER_T,            
    SR_CONTAINER_PRESENCE_T,   
    SR_LEAF_EMPTY_T,           
    SR_NOTIFICATION_T,         
    /* types containing some data */
    SR_BINARY_T,       
    SR_BITS_T,         
    SR_BOOL_T,         
    SR_DECIMAL64_T,    
    SR_ENUM_T,         
    SR_IDENTITYREF_T,  
    SR_INSTANCEID_T,   
    SR_INT8_T,         
    SR_INT16_T,        
    SR_INT32_T,        
    SR_INT64_T,        
    SR_STRING_T,       
    SR_UINT8_T,        
    SR_UINT16_T,       
    SR_UINT32_T,       
    SR_UINT64_T,       
    SR_ANYXML_T,       
    SR_ANYDATA_T       
} sr_val_type_t;

typedef union {
    char *binary_val;       
    char *bits_val;         
    int bool_val;           
    double decimal64_val;   
    char *enum_val;         
    char *identityref_val;  
    char *instanceid_val;   
    int8_t int8_val;        
    int16_t int16_val;      
    int32_t int32_val;      
    int64_t int64_val;      
    char *string_val;       
    uint8_t uint8_val;      
    uint16_t uint16_val;    
    uint32_t uint32_val;    
    uint64_t uint64_val;    
    char *anyxml_val;       
    char *anydata_val;      
} sr_val_data_t;

typedef struct {
    char *xpath;

    sr_val_type_t type;

    int dflt;

    char *origin;

    sr_val_data_t data;
} sr_val_t;

typedef enum {
    SR_OPER_DEFAULT = 0x00,          
    SR_OPER_NO_STATE = 0x01,         
    SR_OPER_NO_CONFIG = 0x02,        
    SR_OPER_NO_SUBS = 0x04,          
    SR_OPER_NO_STORED = 0x08,        
    SR_OPER_WITH_ORIGIN = 0x10,      
    SR_OPER_NO_POLL_CACHED = 0x20,   
    SR_OPER_NO_RUN_CACHED = 0x40     
} sr_get_oper_flag_t;

#define SR_OPER_MASK 0xFFFF          
typedef enum {
    SR_GET_NO_FILTER = 0x010000      
} sr_get_flag_t;

typedef uint32_t sr_get_options_t;

typedef enum {
    SR_EDIT_DEFAULT = 0x0,      
    SR_EDIT_NON_RECURSIVE = 0x1,
    SR_EDIT_STRICT = 0x2,       
    SR_EDIT_ISOLATE = 0x4       
} sr_edit_flag_t;

typedef uint32_t sr_edit_options_t;

typedef enum {
    SR_MOVE_BEFORE = 0,    
    SR_MOVE_AFTER = 1,     
    SR_MOVE_FIRST = 2,     
    SR_MOVE_LAST = 3       
} sr_move_position_t;

typedef enum {
    SR_SUBSCR_DEFAULT = 0x00,

    SR_SUBSCR_NO_THREAD = 0x01,

    SR_SUBSCR_PASSIVE = 0x02,

    SR_SUBSCR_DONE_ONLY = 0x04,

    SR_SUBSCR_ENABLED = 0x08,

    SR_SUBSCR_UPDATE = 0x10,

    SR_SUBSCR_OPER_MERGE = 0x20,

    SR_SUBSCR_THREAD_SUSPEND = 0x40,

    SR_SUBSCR_OPER_POLL_DIFF = 0x80,

    SR_SUBSCR_FILTER_ORIG = 0x100

} sr_subscr_flag_t;

typedef struct sr_subscription_ctx_s sr_subscription_ctx_t;

typedef uint32_t sr_subscr_options_t;

typedef enum {
    SR_EV_UPDATE,  
    SR_EV_CHANGE,  
    SR_EV_DONE,    
    SR_EV_ABORT,   
    SR_EV_ENABLED, 
    SR_EV_RPC      
} sr_event_t;

typedef enum {
    SR_OP_CREATED,   
    SR_OP_MODIFIED,  
    SR_OP_DELETED,   
    SR_OP_MOVED      
} sr_change_oper_t;

typedef struct sr_change_iter_s sr_change_iter_t;

typedef int (*sr_module_change_cb)(sr_session_ctx_t *session, uint32_t sub_id, const char *module_name, const char *xpath,
        sr_event_t event, uint32_t request_id, void *private_data);

typedef int (*sr_rpc_cb)(sr_session_ctx_t *session, uint32_t sub_id, const char *xpath, const sr_val_t *input,
        const size_t input_cnt, sr_event_t event, uint32_t request_id, sr_val_t **output, size_t *output_cnt,
        void *private_data);

typedef int (*sr_rpc_tree_cb)(sr_session_ctx_t *session, uint32_t sub_id, const char *op_path, const struct lyd_node *input,
        sr_event_t event, uint32_t request_id, struct lyd_node *output, void *private_data);

typedef enum {
    SR_EV_NOTIF_REALTIME,         
    SR_EV_NOTIF_REPLAY,           
    SR_EV_NOTIF_REPLAY_COMPLETE,  
    SR_EV_NOTIF_TERMINATED,       
    SR_EV_NOTIF_MODIFIED,         
    SR_EV_NOTIF_SUSPENDED,        
    SR_EV_NOTIF_RESUMED,          
    SR_EV_NOTIF_STOP_TIME         
} sr_ev_notif_type_t;

typedef void (*sr_event_notif_cb)(sr_session_ctx_t *session, uint32_t sub_id, const sr_ev_notif_type_t notif_type,
        const char *xpath, const sr_val_t *values, const size_t values_cnt, struct timespec *timestamp, void *private_data);

typedef void (*sr_event_notif_tree_cb)(sr_session_ctx_t *session, uint32_t sub_id, const sr_ev_notif_type_t notif_type,
        const struct lyd_node *notif, struct timespec *timestamp, void *private_data);

typedef int (*sr_oper_get_items_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);

typedef int (*srp_init_cb_t)(sr_session_ctx_t *session, void **private_data);

typedef void (*srp_cleanup_cb_t)(sr_session_ctx_t *session, void *private_data);

#ifdef __cplusplus
}
#endif

#endif /* _SYSREPO_TYPES_H */