libnetconf2 2.0.24
NETCONF server and client library in C.
Loading...
Searching...
No Matches
messages_server.h
Go to the documentation of this file.
1
15#ifndef NC_MESSAGES_SERVER_H_
16#define NC_MESSAGES_SERVER_H_
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
22#include <libyang/libyang.h>
23#include <stdint.h>
24
25#include "netconf.h"
26#include "session.h"
27
61
72
76struct nc_server_reply;
77
81struct nc_server_notif;
82
86struct nc_server_error;
87
93struct nc_server_reply *nc_server_reply_ok(void);
94
104struct nc_server_reply *nc_server_reply_data(struct lyd_node *data, NC_WD_MODE wd, NC_PARAMTYPE paramtype);
105
112struct nc_server_reply *nc_server_reply_err(struct lyd_node *err);
113
121int nc_server_reply_add_err(struct nc_server_reply *reply, struct lyd_node *err);
122
129const struct lyd_node *nc_server_reply_get_last_err(const struct nc_server_reply *reply);
130
170struct lyd_node *nc_err(const struct ly_ctx *ctx, NC_ERR tag, ...);
171
178NC_ERR_TYPE nc_err_get_type(const struct lyd_node *err);
179
186NC_ERR nc_err_get_tag(const struct lyd_node *err);
187
195int nc_err_set_app_tag(struct lyd_node *err, const char *error_app_tag);
196
203const char *nc_err_get_app_tag(const struct lyd_node *err);
204
212int nc_err_set_path(struct lyd_node *err, const char *error_path);
213
220const char *nc_err_get_path(const struct lyd_node *err);
221
230int nc_err_set_msg(struct lyd_node *err, const char *error_message, const char *lang);
231
238const char *nc_err_get_msg(const struct lyd_node *err);
239
247int nc_err_set_sid(struct lyd_node *err, uint32_t session_id);
248
256int nc_err_add_bad_attr(struct lyd_node *err, const char *attr_name);
257
265int nc_err_add_bad_elem(struct lyd_node *err, const char *elem_name);
266
274int nc_err_add_bad_ns(struct lyd_node *err, const char *ns_name);
275
283int nc_err_add_info_other(struct lyd_node *err, struct lyd_node *other);
284
290void nc_server_reply_free(struct nc_server_reply *reply);
291
303struct nc_server_notif *nc_server_notif_new(struct lyd_node *event, char *eventtime, NC_PARAMTYPE paramtype);
304
317NC_MSG_TYPE nc_server_notif_send(struct nc_session *session, struct nc_server_notif *notif, int timeout);
318
324void nc_server_notif_free(struct nc_server_notif *notif);
325
332const char *nc_server_notif_get_time(const struct nc_server_notif *notif);
333
336#ifdef __cplusplus
337}
338#endif
339
340#endif /* NC_MESSAGES_SERVER_H_ */
NETCONF error structure representation.
NC_MSG_TYPE
Enumeration of NETCONF message types.
Definition netconf.h:69
enum NC_WITHDEFAULTS_MODE NC_WD_MODE
Enumeration of NETCONF with-defaults capability modes.
NC_PARAMTYPE
Enumeration of function parameter treatments.
Definition netconf.h:122
enum NC_ERROR_TYPE NC_ERR_TYPE
Enumeration of NETCONF error type (layer)
int nc_err_add_bad_attr(struct lyd_node *err, const char *attr_name)
Add a <bad-attribute> element to an error.
struct nc_server_reply * nc_server_reply_data(struct lyd_node *data, NC_WD_MODE wd, NC_PARAMTYPE paramtype)
Create a DATA rpc-reply object.
int nc_server_reply_add_err(struct nc_server_reply *reply, struct lyd_node *err)
Add another error opaque data node tree to an ERROR rpc-reply object.
NC_ERR_TYPE nc_err_get_type(const struct lyd_node *err)
Get the <error-type> of a server error.
void nc_server_notif_free(struct nc_server_notif *notif)
Free a server Event Notification object.
NC_ERROR
Enumeration of NETCONF errors.
int nc_err_set_sid(struct lyd_node *err, uint32_t session_id)
Set the <session-id> element of an error. Any previous value will be overwritten.
const char * nc_server_notif_get_time(const struct nc_server_notif *notif)
Get the notification timestamp.
NC_MSG_TYPE nc_server_notif_send(struct nc_session *session, struct nc_server_notif *notif, int timeout)
Send NETCONF Event Notification via the session.
int nc_err_set_path(struct lyd_node *err, const char *error_path)
Set the <error-path> element of an error. Any previous value will be overwritten.
void nc_server_reply_free(struct nc_server_reply *reply)
Free a server rpc-reply object.
enum NC_ERROR NC_ERR
Enumeration of NETCONF errors.
int nc_err_add_bad_elem(struct lyd_node *err, const char *elem_name)
Add a <bad-element> element to an error.
struct nc_server_reply * nc_server_reply_ok(void)
Create an OK rpc-reply object.
int nc_err_set_app_tag(struct lyd_node *err, const char *error_app_tag)
Set the <error-app-tag> element of an error. Any previous value will be overwritten.
const char * nc_err_get_msg(const struct lyd_node *err)
Get the <error-message> of a server error.
int nc_err_set_msg(struct lyd_node *err, const char *error_message, const char *lang)
Set the <error-message> element of an error. Any previous value will be overwritten.
int nc_err_add_info_other(struct lyd_node *err, struct lyd_node *other)
Add an additional custom element to an error.
int nc_err_add_bad_ns(struct lyd_node *err, const char *ns_name)
Add a <bad-namespace> element to an error.
NC_ERR nc_err_get_tag(const struct lyd_node *err)
Get the <error-tag> of a server error.
const char * nc_err_get_path(const struct lyd_node *err)
Get the <error-path> of a server error.
const char * nc_err_get_app_tag(const struct lyd_node *err)
Get the <error-app-tag> of a server error.
struct nc_server_notif * nc_server_notif_new(struct lyd_node *event, char *eventtime, NC_PARAMTYPE paramtype)
Create Event Notification object to be sent to the subscribed client(s).
struct nc_server_reply * nc_server_reply_err(struct lyd_node *err)
Create an ERROR rpc-reply object.
const struct lyd_node * nc_server_reply_get_last_err(const struct nc_server_reply *reply)
Get last error from an ERROR rpc-reply object.
NC_ERROR_TYPE
Enumeration of NETCONF error type (layer)
@ NC_ERR_RES_DENIED
@ NC_ERR_INVALID_VALUE
@ NC_ERR_ROLLBACK_FAILED
@ NC_ERR_UNKNOWN_ATTR
@ NC_ERR_UNKNOWN
@ NC_ERR_BAD_ATTR
@ NC_ERR_DATA_EXISTS
@ NC_ERR_IN_USE
@ NC_ERR_UNKNOWN_ELEM
@ NC_ERR_ACCESS_DENIED
@ NC_ERR_OP_NOT_SUPPORTED
@ NC_ERR_UNKNOWN_NS
@ NC_ERR_MISSING_ATTR
@ NC_ERR_LOCK_DENIED
@ NC_ERR_MALFORMED_MSG
@ NC_ERR_DATA_MISSING
@ NC_ERR_BAD_ELEM
@ NC_ERR_MISSING_ELEM
@ NC_ERR_TOO_BIG
@ NC_ERR_OP_FAILED
@ NC_ERR_TYPE_RPC
@ NC_ERR_TYPE_UNKNOWN
@ NC_ERR_TYPE_TRAN
@ NC_ERR_TYPE_APP
@ NC_ERR_TYPE_PROT
libnetconf2's general public functions and structures definitions.
libnetconf2 session manipulation