libnetconf2  1.1.26
NETCONF library for clients and servers
session.h
Go to the documentation of this file.
1 
15 #ifndef NC_SESSION_H_
16 #define NC_SESSION_H_
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
22 #include "netconf.h"
23 
24 #ifdef NC_ENABLED_SSH
25 
29 typedef enum {
34 
35 #endif /* NC_ENABLED_SSH */
36 
37 #ifdef NC_ENABLED_TLS
38 
42 typedef enum {
51 
52 #endif /* NC_ENABLED_TLS */
53 
57 typedef enum {
64 
68 typedef enum {
69  NC_TI_NONE = 0,
70  NC_TI_FD,
73 #ifdef NC_ENABLED_SSH
75 #endif
76 #ifdef NC_ENABLED_TLS
78 #endif
80 
84 typedef enum {
89 
93 typedef enum {
94  NC_CH_FIRST_LISTED = 0, //default
98 
102 typedef enum {
108 
112 struct nc_session;
113 
120 NC_STATUS nc_session_get_status(const struct nc_session *session);
121 
128 NC_SESSION_TERM_REASON nc_session_get_term_reason(const struct nc_session *session);
129 
136 uint32_t nc_session_get_killed_by(const struct nc_session *session);
137 
144 uint32_t nc_session_get_id(const struct nc_session *session);
145 
152 int nc_session_get_version(const struct nc_session *session);
153 
160 NC_TRANSPORT_IMPL nc_session_get_ti(const struct nc_session *session);
161 
168 const char *nc_session_get_username(const struct nc_session *session);
169 
176 const char *nc_session_get_host(const struct nc_session *session);
177 
184 uint16_t nc_session_get_port(const struct nc_session *session);
185 
192 const char *nc_session_get_path(const struct nc_session *session);
193 
200 struct ly_ctx *nc_session_get_ctx(const struct nc_session *session);
201 
208 void nc_session_set_data(struct nc_session *session, void *data);
209 
216 void *nc_session_get_data(const struct nc_session *session);
217 
224 void nc_session_free(struct nc_session *session, void (*data_free)(void *));
225 
226 #if defined(NC_ENABLED_SSH) || defined(NC_ENABLED_TLS)
227 
236 void nc_thread_destroy(void);
237 
238 #endif /* NC_ENABLED_SSH || NC_ENABLED_TLS */
239 
240 #ifdef __cplusplus
241 }
242 #endif
243 
244 #endif /* NC_SESSION_H_ */
NC_SESSION_TERM_REASON
Enumeration of reasons of the NETCONF session termination as defined in RFC 6470.
Definition: netconf.h:55
libnetconf2's general public functions and structures definitions.
NC_TLS_CTN_MAPTYPE
Enumeration of cert-to-name mapping types.
Definition: session.h:42
@ NC_TLS_CTN_SAN_ANY
Definition: session.h:48
@ NC_TLS_CTN_SAN_IP_ADDRESS
Definition: session.h:47
@ NC_TLS_CTN_SAN_RFC822_NAME
Definition: session.h:45
@ NC_TLS_CTN_SPECIFIED
Definition: session.h:44
@ NC_TLS_CTN_SAN_DNS_NAME
Definition: session.h:46
@ NC_TLS_CTN_UNKNOWN
Definition: session.h:43
@ NC_TLS_CTN_COMMON_NAME
Definition: session.h:49
NC_STATUS
Enumeration of possible session statuses.
Definition: session.h:57
@ NC_STATUS_INVALID
Definition: session.h:61
@ NC_STATUS_RUNNING
Definition: session.h:62
@ NC_STATUS_ERR
Definition: session.h:58
@ NC_STATUS_STARTING
Definition: session.h:59
@ NC_STATUS_CLOSING
Definition: session.h:60
void nc_session_free(struct nc_session *session, void(*data_free)(void *))
Free the NETCONF session object.
NC_CH_START_WITH
Enumeration of Call Home client priority policy.
Definition: session.h:93
@ NC_CH_LAST_CONNECTED
Definition: session.h:95
@ NC_CH_FIRST_LISTED
Definition: session.h:94
@ NC_CH_RANDOM
Definition: session.h:96
NC_STATUS nc_session_get_status(const struct nc_session *session)
Get session status.
NC_SESSION_TERM_REASON nc_session_get_term_reason(const struct nc_session *session)
Get session termination reason.
const char * nc_session_get_path(const struct nc_session *session)
Get session path (unix socket only).
NC_CH_CONN_TYPE
Enumeration of Call Home connection types.
Definition: session.h:84
@ NC_CH_PERSIST
Definition: session.h:86
@ NC_CH_PERIOD
Definition: session.h:87
@ NC_CH_CT_NOT_SET
Definition: session.h:85
const char * nc_session_get_host(const struct nc_session *session)
Get session host.
void nc_thread_destroy(void)
Free all the dynamically allocated thread-specific libssl/libcrypto resources.
struct ly_ctx * nc_session_get_ctx(const struct nc_session *session)
Get session context.
NC_SSH_KEY_TYPE
Enumeration of SSH key types.
Definition: session.h:102
@ NC_SSH_KEY_DSA
Definition: session.h:104
@ NC_SSH_KEY_ECDSA
Definition: session.h:106
@ NC_SSH_KEY_RSA
Definition: session.h:105
@ NC_SSH_KEY_UNKNOWN
Definition: session.h:103
NC_TRANSPORT_IMPL
Enumeration of transport implementations (ways how libnetconf implements NETCONF transport protocol)
Definition: session.h:68
@ NC_TI_OPENSSL
Definition: session.h:77
@ NC_TI_UNIX
Definition: session.h:72
@ NC_TI_FD
Definition: session.h:70
@ NC_TI_NONE
Definition: session.h:69
@ NC_TI_LIBSSH
Definition: session.h:74
void * nc_session_get_data(const struct nc_session *session)
Get the data assigned to a session.
int nc_session_get_version(const struct nc_session *session)
Get session NETCONF version.
NC_SSH_AUTH_TYPE
Enumeration of NETCONF SSH authentication methods.
Definition: session.h:29
@ NC_SSH_AUTH_INTERACTIVE
Definition: session.h:32
@ NC_SSH_AUTH_PASSWORD
Definition: session.h:31
@ NC_SSH_AUTH_PUBLICKEY
Definition: session.h:30
const char * nc_session_get_username(const struct nc_session *session)
Get session username.
void nc_session_set_data(struct nc_session *session, void *data)
Assign arbitrary data to a session.
uint16_t nc_session_get_port(const struct nc_session *session)
Get session port.
NC_TRANSPORT_IMPL nc_session_get_ti(const struct nc_session *session)
Get session transport used.
uint32_t nc_session_get_id(const struct nc_session *session)
Get session ID.
uint32_t nc_session_get_killed_by(const struct nc_session *session)
Get session killer session ID.