transapi.h

Go to the documentation of this file.

#ifndef NC_TRANSAPI_H
#define NC_TRANSAPI_H

#include <sys/inotify.h>
#include <libxml/tree.h>
#include "netconf.h"
#include "error.h"

#ifdef __cplusplus
extern "C" {
#endif

/* Current transAPI version */
#define TRANSAPI_VERSION 6

/* maximal number of input arguments every defined RPC can have */
#ifndef MAX_RPC_INPUT_ARGS
#       define MAX_RPC_INPUT_ARGS 64
#endif

typedef enum
{
        XMLDIFF_ERR = -1 ,
        XMLDIFF_NONE = 0 ,
        XMLDIFF_ADD = 1 ,
        XMLDIFF_REM = 2 ,
        XMLDIFF_MOD = 4,
        XMLDIFF_CHAIN = 8,
        XMLDIFF_SIBLING = 16 ,
        XMLDIFF_REORDER = 32 ,
} XMLDIFF_OP;

typedef enum TRANSAPI_CLBCKS_ORDER_TYPE {
        TRANSAPI_CLBCKS_LEAF_TO_ROOT,
        TRANSAPI_CLBCKS_ROOT_TO_LEAF,
        TRANSAPI_CLBCKS_ORDER_DEFAULT = TRANSAPI_CLBCKS_LEAF_TO_ROOT,
} TRANSAPI_CLBCKS_ORDER_TYPE;

typedef enum
{
        CLBCKS_APPLIED_NONE,
        CLBCKS_APPLYING_CHILDREN,
        CLBCKS_APPLIED_ERROR,
        CLBCKS_APPLIED_NO_ERROR,
        CLBCKS_APPLIED_CHILDREN_ERROR,
        CLBCKS_APPLIED_CHILDREN_NO_ERROR,
        CLBCKS_APPLIED_NOT_FULLY,
        CLBCKS_APPLIED_FULLY
} CLBCKS_APPLIED;


struct ns_pair {
        const char* prefix;
        const char* href;
};

struct transapi {
        int version;
        int (*init)(xmlDocPtr *);
        void (*close)(void);
        xmlDocPtr (*get_state)(const xmlDocPtr, const xmlDocPtr, struct nc_err**);
        TRANSAPI_CLBCKS_ORDER_TYPE clbks_order;
        struct transapi_data_callbacks* data_clbks;
        struct transapi_rpc_callbacks* rpc_clbks;
        struct ns_pair* ns_mapping;
        int* config_modified;
        NC_EDIT_ERROPT_TYPE *erropt;
        struct transapi_file_callbacks* file_clbks;
};

struct clbk {
        char* path;
        int (*func)(void**, XMLDIFF_OP, xmlNodePtr, xmlNodePtr, struct nc_err**);
};

struct transapi_data_callbacks {
        int callbacks_count;
        void* data;
        struct clbk callbacks[];
};

struct transapi_rpc_callbacks {
        int callbacks_count;
        struct {
                char* name;
                nc_reply* (*func)(xmlNodePtr);
        } callbacks[];
};

struct transapi_file_callbacks {
        int callbacks_count;
        struct {
                const char* path;
                int (*func)(const char*, xmlDocPtr*, int*);
        } callbacks[];
};

#ifdef __cplusplus
}
#endif

#endif /* NC_TRANSAPI_H */