15 #ifndef NC_MESSAGES_SERVER_H_
16 #define NC_MESSAGES_SERVER_H_
23 #include <libyang/libyang.h>
76 struct nc_server_reply;
81 struct nc_server_notif;
86 struct nc_server_error;
169 struct nc_server_error *
nc_err(
int tag, ...);
222 int nc_err_set_path(
struct nc_server_error *err,
const char *error_path);
240 int nc_err_set_msg(
struct nc_server_error *err,
const char *error_message,
const char *lang);
257 int nc_err_set_sid(
struct nc_server_error *err, uint32_t session_id);
NC_MSG_TYPE
Enumeration of NETCONF message types.
NC_ERR nc_err_get_tag(const struct nc_server_error *err)
Get the <error-tag> of a server error.
int nc_err_add_bad_ns(struct nc_server_error *err, const char *ns_name)
Add a <bad-namespace> element to an error.
enum NC_ERROR_TYPE NC_ERR_TYPE
Enumeration of NETCONF error type (layer)
int nc_err_set_sid(struct nc_server_error *err, uint32_t session_id)
Set the <session-id> element of an error. Any previous value will be overwritten. ...
libnetconf2 session manipulation
const char * nc_server_notif_get_time(const struct nc_server_notif *notif)
Get the notification timestamp.
int nc_err_set_path(struct nc_server_error *err, const char *error_path)
Set the <error-path> element of an error. Any previous value will be overwritten. ...
struct nc_server_reply * nc_server_reply_ok(void)
Create an OK rpc-reply object.
void nc_server_reply_free(struct nc_server_reply *reply)
Free a server rpc-reply object.
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).
NC_ERR_TYPE nc_err_get_type(const struct nc_server_error *err)
Get the <error-type> of a server error.
int nc_err_set_msg(struct nc_server_error *err, const char *error_message, const char *lang)
Set the <error-message> element of an error. Any previous value will be overwritten.
int nc_server_reply_add_err(struct nc_server_reply *reply, struct nc_server_error *err)
Add another error to an ERROR rpc-reply object. It will be freed with the returned object...
NC_PARAMTYPE
Enumeration of function parameter treatments.
struct nc_server_reply * nc_server_reply_err(struct nc_server_error *err)
Create an ERROR rpc-reply object.
int nc_err_set_app_tag(struct nc_server_error *err, const char *error_app_tag)
Set the <error-app-tag> element of an error. Any previous value will be overwritten.
NC_ERROR_TYPE
Enumeration of NETCONF error type (layer)
enum NC_WITHDEFAULTS_MODE NC_WD_MODE
Enumeration of NETCONF with-defaults capability modes.
int nc_err_add_info_other(struct nc_server_error *err, struct lyxml_elem *other)
Add an additional custom element to an error.
int nc_err_add_bad_elem(struct nc_server_error *err, const char *elem_name)
Add a <bad-element> 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.
struct nc_server_error * nc_server_reply_get_last_err(const struct nc_server_reply *reply)
Get last error from an ERROR rpy-reply object.
const char * nc_err_get_msg(const struct nc_server_error *err)
Get the <error-message> of a server error.
void nc_err_free(struct nc_server_error *err)
Free a server error structure.
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.
enum NC_ERROR NC_ERR
Enumeration of NETCONF errors.
void nc_server_notif_free(struct nc_server_notif *notif)
Free a server Event Notification object.
struct nc_server_error * nc_err(int tag,...)
Create a server error structure. Its <error-message> is filled with a general description of the spec...
int nc_err_add_bad_attr(struct nc_server_error *err, const char *attr_name)
Add a <bad-attribute> element to an error.
const char * nc_err_get_app_tag(const struct nc_server_error *err)
Get the <error-app-tag> of a server error.
libnetconf2's general public functions and structures definitions.
const char * nc_err_get_path(const struct nc_server_error *err)
Get the <error-path> of a server error.
NC_ERROR
Enumeration of NETCONF errors.
struct nc_server_error * nc_err_libyang(struct ly_ctx *ctx)
Create a server error structure based on libyang error.