session.h

Go to the documentation of this file.

#ifndef NC_SESSION_H_
#define NC_SESSION_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "netconf.h"

#ifdef NC_ENABLED_SSH

typedef enum {
    NC_SSH_AUTH_PUBLICKEY = 0x01,  
    NC_SSH_AUTH_PASSWORD = 0x02,   
    NC_SSH_AUTH_INTERACTIVE = 0x04 
} NC_SSH_AUTH_TYPE;

#endif /* NC_ENABLED_SSH */

#ifdef NC_ENABLED_TLS

typedef enum {
    NC_TLS_CTN_UNKNOWN = 0,     
    NC_TLS_CTN_SPECIFIED,       
    NC_TLS_CTN_SAN_RFC822_NAME, 
    NC_TLS_CTN_SAN_DNS_NAME,    
    NC_TLS_CTN_SAN_IP_ADDRESS,  
    NC_TLS_CTN_SAN_ANY,         
    NC_TLS_CTN_COMMON_NAME      
} NC_TLS_CTN_MAPTYPE;

#endif /* NC_ENABLED_TLS */

typedef enum {
    NC_STATUS_ERR = -1,   
    NC_STATUS_STARTING = 0, 
    NC_STATUS_CLOSING,      
    NC_STATUS_INVALID,      
    NC_STATUS_RUNNING       
} NC_STATUS;

typedef enum {
    NC_TI_NONE = 0,   
    NC_TI_FD,         
    NC_TI_UNIX,       
#ifdef NC_ENABLED_SSH
    NC_TI_LIBSSH,     
#endif
#ifdef NC_ENABLED_TLS
    NC_TI_OPENSSL     
#endif
} NC_TRANSPORT_IMPL;

typedef enum {
    NC_CH_CT_NOT_SET = 0,
    NC_CH_PERSIST,
    NC_CH_PERIOD
} NC_CH_CONN_TYPE;

typedef enum {
    NC_CH_FIRST_LISTED = 0, //default
    NC_CH_LAST_CONNECTED,
    NC_CH_RANDOM
} NC_CH_START_WITH;

typedef enum {
    NC_SSH_KEY_UNKNOWN = 0,
    NC_SSH_KEY_DSA,
    NC_SSH_KEY_RSA,
    NC_SSH_KEY_ECDSA
} NC_SSH_KEY_TYPE;

struct nc_session;

NC_STATUS nc_session_get_status(const struct nc_session *session);

NC_SESSION_TERM_REASON nc_session_get_term_reason(const struct nc_session *session);

uint32_t nc_session_get_killed_by(const struct nc_session *session);

uint32_t nc_session_get_id(const struct nc_session *session);

uint32_t nc_session_get_refcnt(const struct nc_session *session);
void nc_session_reference(struct nc_session *session);
void nc_session_dereference(struct nc_session *session);

int nc_session_get_version(const struct nc_session *session);

NC_TRANSPORT_IMPL nc_session_get_ti(const struct nc_session *session);

const char *nc_session_get_username(const struct nc_session *session);

const char *nc_session_get_host(const struct nc_session *session);

uint16_t nc_session_get_port(const struct nc_session *session);

const char *nc_session_get_path(const struct nc_session *session);

struct ly_ctx *nc_session_get_ctx(const struct nc_session *session);

void nc_session_set_data(struct nc_session *session, void *data);

void *nc_session_get_data(const struct nc_session *session);

void nc_session_free(struct nc_session *session, void (*data_free)(void *));

#if defined(NC_ENABLED_SSH) || defined(NC_ENABLED_TLS)

void nc_thread_destroy(void);

#endif /* NC_ENABLED_SSH || NC_ENABLED_TLS */

#ifdef __cplusplus
}
#endif

#endif /* NC_SESSION_H_ */