plugins_datastore.h

Go to the documentation of this file.

#ifndef _SYSREPO_PLUGINS_DATASTORE_H
#define _SYSREPO_PLUGINS_DATASTORE_H

#include <stdint.h>
#include <sys/types.h>

#include <libyang/libyang.h>

#include "sysrepo_types.h"

#ifdef __cplusplus
extern "C" {
#endif

// Datastore Plugin API

#define SRPLG_DS_API_VERSION 12

typedef sr_error_info_t *(*srds_install)(const struct lys_module *mod, sr_datastore_t ds, const char *owner,
        const char *group, mode_t perm, void *plg_data);

typedef sr_error_info_t *(*srds_uninstall)(const struct lys_module *mod, sr_datastore_t ds, void *plg_data);

typedef sr_error_info_t *(*srds_init)(const struct lys_module *mod, sr_datastore_t ds, void *plg_data);

typedef sr_error_info_t *(*srds_conn_init)(sr_conn_ctx_t *conn, void **plg_data);

typedef void (*srds_conn_destroy)(sr_conn_ctx_t *conn, void *plg_data);

typedef sr_error_info_t *(*srds_store)(const struct lys_module *mod, sr_datastore_t ds, sr_cid_t cid, uint32_t sid,
        const struct lyd_node *mod_diff, const struct lyd_node *mod_data, void *plg_data);

typedef sr_error_info_t *(*srds_load)(const struct lys_module *mod, sr_datastore_t ds, sr_cid_t cid, uint32_t sid,
        const char **xpaths, uint32_t xpath_count, void *plg_data, struct lyd_node **mod_data);

typedef sr_error_info_t *(*srds_copy)(const struct lys_module *mod, sr_datastore_t trg_ds, sr_datastore_t src_ds,
        void *plg_data);

typedef sr_error_info_t *(*srds_candidate_modified)(const struct lys_module *mod, void *plg_data, int *modified);

typedef sr_error_info_t *(*srds_candidate_reset)(const struct lys_module *mod, void *plg_data);

typedef sr_error_info_t *(*srds_access_set)(const struct lys_module *mod, sr_datastore_t ds, const char *owner,
        const char *group, mode_t perm, void *plg_data);

typedef sr_error_info_t *(*srds_access_get)(const struct lys_module *mod, sr_datastore_t ds, void *plg_data, char **owner,
        char **group, mode_t *perm);

typedef sr_error_info_t *(*srds_access_check)(const struct lys_module *mod, sr_datastore_t ds, void *plg_data, int *read,
        int *write);

typedef sr_error_info_t *(*srds_last_modif)(const struct lys_module *mod, sr_datastore_t ds, void *plg_data,
        struct timespec *mtime);

typedef sr_error_info_t *(*srds_data_version)(const struct lys_module *mod, sr_datastore_t ds, void *plg_data,
        uint32_t *version);

struct srplg_ds_s {
    const char *name;               
    srds_install install_cb;        
    srds_uninstall uninstall_cb;    
    srds_init init_cb;              
    srds_conn_init conn_init_cb;    
    srds_conn_destroy conn_destroy_cb;  
    srds_store store_cb;            
    srds_load load_cb;              
    srds_copy copy_cb;              
    srds_candidate_modified candidate_modified_cb;  
    srds_candidate_reset candidate_reset_cb;        
    srds_access_set access_set_cb;  
    srds_access_get access_get_cb;  
    srds_access_check access_check_cb;  
    srds_last_modif last_modif_cb;  
    srds_data_version data_version_cb;  
};

#define SRPLG_DATASTORE \
    uint32_t srpds_apiver__ = SRPLG_DS_API_VERSION; \
    const struct srplg_ds_s srpds__

#ifdef __cplusplus
}
#endif

#endif /* _SYSREPO_PLUGINS_DATASTORE_H */