netconf.h

Go to the documentation of this file.

 
#ifndef NC_NETCONF_H_
#define NC_NETCONF_H_
 
#include <stdint.h>
#include <sys/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct nc_msg;
 
typedef struct nc_msg nc_rpc;
 
typedef struct nc_msg nc_reply;
 
typedef struct nc_msg nc_ntf;
 
struct nc_cpblts;
 
#define nc_msgid char*
 
struct nc_session;
 
struct nc_filter;
 
typedef enum NC_SESSION_STATUS {
        NC_SESSION_STATUS_ERROR = -1, 
        NC_SESSION_STATUS_STARTUP = 0, 
        NC_SESSION_STATUS_WORKING = 1, 
        NC_SESSION_STATUS_CLOSING = 2, 
        NC_SESSION_STATUS_CLOSED = 3, 
        NC_SESSION_STATUS_DUMMY = 4 
} NC_SESSION_STATUS;
 
typedef enum NC_SESSION_TERM_REASON {
        NC_SESSION_TERM_CLOSED, 
        NC_SESSION_TERM_KILLED, 
        NC_SESSION_TERM_DROPPED, 
        NC_SESSION_TERM_TIMEOUT, 
        NC_SESSION_TERM_BADHELLO, 
        NC_SESSION_TERM_OTHER 
} NC_SESSION_TERM_REASON;
 
typedef enum NC_MSG_TYPE {
        NC_MSG_UNKNOWN, 
        NC_MSG_WOULDBLOCK, 
        NC_MSG_NONE, 
        NC_MSG_HELLO, 
        NC_MSG_RPC, 
        NC_MSG_REPLY, 
        NC_MSG_NOTIFICATION = -5 
} NC_MSG_TYPE;
 
typedef enum NC_REPLY_TYPE {
        NC_REPLY_UNKNOWN, 
        NC_REPLY_HELLO, 
        NC_REPLY_OK, 
        NC_REPLY_ERROR, 
        NC_REPLY_DATA 
} NC_REPLY_TYPE;
 
typedef enum NC_RPC_TYPE {
        NC_RPC_UNKNOWN, 
        NC_RPC_HELLO, 
        NC_RPC_DATASTORE_READ, 
        NC_RPC_DATASTORE_WRITE, 
        NC_RPC_SESSION 
} NC_RPC_TYPE;
 
typedef enum NC_NOTIF_TYPE {
        NC_NTF_UNKNOWN,
        NC_NTF_BASE
} NC_NOTIF_TYPE;
 
typedef enum NC_OP {
        NC_OP_UNKNOWN,          
        NC_OP_GETCONFIG,        
        NC_OP_GET,              
        NC_OP_EDITCONFIG,       
        NC_OP_CLOSESESSION,     
        NC_OP_KILLSESSION,      
        NC_OP_COPYCONFIG,       
        NC_OP_DELETECONFIG,     
        NC_OP_LOCK,             
        NC_OP_UNLOCK,           
        NC_OP_COMMIT,           
        NC_OP_DISCARDCHANGES,   
        NC_OP_CANCELCOMMIT,     
        NC_OP_CREATESUBSCRIPTION,       
        NC_OP_GETSCHEMA,        
        NC_OP_VALIDATE          
} NC_OP;
 
typedef enum NC_ERR_PARAM {
        NC_ERR_PARAM_TYPE,
        NC_ERR_PARAM_TAG,
        NC_ERR_PARAM_SEVERITY,
        NC_ERR_PARAM_APPTAG,
        NC_ERR_PARAM_PATH,
        NC_ERR_PARAM_MSG,
        NC_ERR_PARAM_INFO_BADATTR,
        NC_ERR_PARAM_INFO_BADELEM,
        NC_ERR_PARAM_INFO_BADNS,
        NC_ERR_PARAM_INFO_SID
} NC_ERR_PARAM;
 
typedef enum NC_DATASTORE_TYPE {
        NC_DATASTORE_ERROR, 
        NC_DATASTORE_CONFIG, 
        NC_DATASTORE_URL, 
        NC_DATASTORE_RUNNING, 
        NC_DATASTORE_STARTUP, 
        NC_DATASTORE_CANDIDATE 
} NC_DATASTORE;
 
typedef enum NC_FILTER_TYPE {
        NC_FILTER_UNKNOWN, 
        NC_FILTER_SUBTREE  
} NC_FILTER_TYPE;
 
typedef enum NC_EDIT_OP_TYPE {
        NC_EDIT_OP_ERROR = -1,  
        NC_EDIT_OP_MERGE = 1,   
        NC_EDIT_OP_NOTSET = 0,  
        NC_EDIT_OP_REPLACE = 2, 
        NC_EDIT_OP_CREATE,      
        NC_EDIT_OP_DELETE,      
        NC_EDIT_OP_REMOVE       
} NC_EDIT_OP_TYPE;
 
typedef enum NC_EDIT_DEFOP_TYPE {
        NC_EDIT_DEFOP_ERROR = -1,  
        NC_EDIT_DEFOP_NOTSET = 0,  
        NC_EDIT_DEFOP_MERGE = 1,   
        NC_EDIT_DEFOP_REPLACE = 2, 
        NC_EDIT_DEFOP_NONE = 3     
} NC_EDIT_DEFOP_TYPE;
 
typedef enum NC_EDIT_ERROPT_TYPE {
        NC_EDIT_ERROPT_ERROR = -1,   
        NC_EDIT_ERROPT_NOTSET = 0,   
        NC_EDIT_ERROPT_STOP = 1,     
        NC_EDIT_ERROPT_CONT = 2,     
        NC_EDIT_ERROPT_ROLLBACK = 3  
} NC_EDIT_ERROPT_TYPE;
 
typedef enum NC_EDIT_TESTOPT_TYPE {
        NC_EDIT_TESTOPT_ERROR = -1,  
        NC_EDIT_TESTOPT_NOTSET = 0,  
        NC_EDIT_TESTOPT_TESTSET = 1, 
        NC_EDIT_TESTOPT_SET = 2,     
        NC_EDIT_TESTOPT_TEST = 3     
} NC_EDIT_TESTOPT_TYPE;
 
typedef enum NCWD_MODE {
        NCWD_MODE_NOTSET = 0,     
        NCWD_MODE_ALL = 1,        
        NCWD_MODE_TRIM = 2,       
        NCWD_MODE_EXPLICIT = 4,   
        NCWD_MODE_ALL_TAGGED = 8  
} NCWD_MODE;
 
typedef enum NC_CAP_ATTR {
        NC_CAP_ATTR_WITHDEFAULTS_MODE = 1  
} NC_CAP_ATTR;
 
typedef enum NC_VERB_LEVEL {
        NC_VERB_ERROR,  
        NC_VERB_WARNING,
        NC_VERB_VERBOSE,
        NC_VERB_DEBUG   
} NC_VERB_LEVEL;
 
void nc_verbosity(NC_VERB_LEVEL level);
 
void nc_verb_error(const char * format, ...);
 
void nc_verb_warning(const char * format, ...);
 
void nc_verb_verbose(const char * format, ...);
 
typedef enum NC_TRANSPORT {
        NC_TRANSPORT_UNKNOWN = -1, 
        NC_TRANSPORT_SSH, 
        NC_TRANSPORT_TLS 
} NC_TRANSPORT;
 
int nc_init(int flags);
 
/*
 * The difference between single and multi-layer server affects only
 * nc_init() and nc_close() calls. Generally, single-layer application
 * can be executed and finish several times, even during a single
 * NETCONF session. A multi-layer application is expected to call
 * nc_close() only after it actually finished all its work and no
 * client is connected.
 */
#define NC_INIT_MULTILAYER 0x00001000  
#define NC_INIT_SINGLELAYER 0x00002000 
#define NC_INIT_CLIENT 0x00004000      
#define NC_INIT_ALL        0xffff8fff 
#define NC_INIT_NOTIF      0x00000002 
#define NC_INIT_NACM       0x00000004 
#define NC_INIT_MONITORING 0x00000008 
#define NC_INIT_WD         0x00000010 
#define NC_INIT_VALIDATE   0x00000020 
#define NC_INIT_URL        0x00000040 
#define NC_INIT_KEEPALIVECHECK  0x00000080 
#define NC_INIT_DATASTORES 0x00000100 
#define NC_INIT_LIBSSH_PTHREAD 0x00000200 
#define NC_INITRET_NOTFIRST 0x00000001 
#define NC_INITRET_RECOVERY 0x00000002 
int nc_close(void);
 
char* nc_time2datetime(time_t time, const char* tz);
 
time_t nc_datetime2time(const char* datetime);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NC_NETCONF_H_ */