messages_client.h

Go to the documentation of this file.

#ifndef NC_MESSAGES_CLIENT_H_
#define NC_MESSAGES_CLIENT_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#include "netconf.h"

typedef enum {
    NC_RPC_UNKNOWN = 0, 
    NC_RPC_ACT_GENERIC, 
    /* ietf-netconf */
    NC_RPC_GETCONFIG,   
    NC_RPC_EDIT,        
    NC_RPC_COPY,        
    NC_RPC_DELETE,      
    NC_RPC_LOCK,        
    NC_RPC_UNLOCK,      
    NC_RPC_GET,         
    NC_RPC_KILL,        
    NC_RPC_COMMIT,      
    NC_RPC_DISCARD,     
    NC_RPC_CANCEL,      
    NC_RPC_VALIDATE,    
    /* ietf-netconf-monitoring */
    NC_RPC_GETSCHEMA,   
    /* notifications */
    NC_RPC_SUBSCRIBE,   
    /* ietf-netconf-nmda */
    NC_RPC_GETDATA,     
    NC_RPC_EDITDATA,    
} NC_RPC_TYPE;

typedef enum {
    NC_RPC_EDIT_DFLTOP_UNKNOWN = 0, 
    NC_RPC_EDIT_DFLTOP_MERGE,       
    NC_RPC_EDIT_DFLTOP_REPLACE,     
    NC_RPC_EDIT_DFLTOP_NONE         
} NC_RPC_EDIT_DFLTOP;

typedef enum {
    NC_RPC_EDIT_TESTOPT_UNKNOWN = 0, 
    NC_RPC_EDIT_TESTOPT_TESTSET,     
    NC_RPC_EDIT_TESTOPT_SET,         
    NC_RPC_EDIT_TESTOPT_TEST         
} NC_RPC_EDIT_TESTOPT;

typedef enum {
    NC_RPC_EDIT_ERROPT_UNKNOWN = 0, 
    NC_RPC_EDIT_ERROPT_STOP,        
    NC_RPC_EDIT_ERROPT_CONTINUE,    
    NC_RPC_EDIT_ERROPT_ROLLBACK     
} NC_RPC_EDIT_ERROPT;

struct nc_err {
    const char *type;
    const char *tag;
    const char *severity;
    const char *apptag;
    const char *path;
    const char *message;
    const char *message_lang;

    /* <error-info> */

    const char *sid;
    const char **attr;
    const char **elem;
    const char **ns;
    struct lyxml_elem **other;

    uint16_t attr_count;
    uint16_t elem_count;
    uint16_t ns_count;
    uint16_t other_count;
};

struct nc_rpc;

struct nc_reply {
    NC_RPL type; 
};

struct nc_reply_data {
    NC_RPL type;            
    struct lyd_node *data;  
};

struct nc_reply_error {
    NC_RPL type;              
    const struct nc_err *err; 
    uint32_t count;           
};

struct nc_notif {
    NC_RPL type;           
    const char *datetime;  
    struct lyd_node *tree; 
};

NC_RPC_TYPE nc_rpc_get_type(const struct nc_rpc *rpc);

struct nc_rpc *nc_rpc_act_generic(const struct lyd_node *data, NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_act_generic_xml(const char *xml_str, NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_getconfig(NC_DATASTORE source, const char *filter, NC_WD_MODE wd_mode,
                                NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_edit(NC_DATASTORE target, NC_RPC_EDIT_DFLTOP default_op, NC_RPC_EDIT_TESTOPT test_opt,
                           NC_RPC_EDIT_ERROPT error_opt, const char *edit_content, NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_copy(NC_DATASTORE target, const char *url_trg, NC_DATASTORE source,
                           const char *url_or_config_src, NC_WD_MODE wd_mode, NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_delete(NC_DATASTORE target, const char *url, NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_lock(NC_DATASTORE target);

struct nc_rpc *nc_rpc_unlock(NC_DATASTORE target);

struct nc_rpc *nc_rpc_get(const char *filter, NC_WD_MODE wd_mode, NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_kill(uint32_t session_id);

struct nc_rpc *nc_rpc_commit(int confirmed, uint32_t confirm_timeout, const char *persist, const char *persist_id,
                             NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_discard(void);

struct nc_rpc *nc_rpc_cancel(const char *persist_id, NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_validate(NC_DATASTORE source, const char *url_or_config, NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_getschema(const char *identifier, const char *version, const char *format, NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_subscribe(const char *stream_name, const char *filter, const char *start_time,
                                const char *stop_time, NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_getdata(const char *datastore, const char *filter, const char *config_filter, char **origin_filter,
                              int origin_filter_count, int neg_origin_filter, uint16_t max_depth, int with_origin,
                              NC_WD_MODE wd_mode, NC_PARAMTYPE paramtype);

struct nc_rpc *nc_rpc_editdata(const char *datastore, NC_RPC_EDIT_DFLTOP default_op, const char *edit_content,
                               NC_PARAMTYPE paramtype);

void nc_rpc_free(struct nc_rpc *rpc);

void nc_reply_free(struct nc_reply *reply);

void nc_notif_free(struct nc_notif *notif);

#ifdef __cplusplus
}
#endif

#endif /* NC_MESSAGES_CLIENT_H_ */