messages_server.h File Reference

libnetconf2's functions and structures of server NETCONF messages. More...

#include <stdarg.h>
#include <stdint.h>
#include <libyang/libyang.h>
#include "netconf.h"
#include "session.h"

Include dependency graph for messages_server.h:

Go to the source code of this file.

Typedefs
typedef enum NC_ERROR	NC_ERR
	Enumeration of NETCONF errors. More...
typedef enum NC_ERROR_TYPE	NC_ERR_TYPE
	Enumeration of NETCONF error type (layer) More...

Enumerations
enum	NC_ERROR {   NC_ERR_UNKNOWN = 0, NC_ERR_IN_USE, NC_ERR_INVALID_VALUE, NC_ERR_TOO_BIG,   NC_ERR_MISSING_ATTR, NC_ERR_BAD_ATTR, NC_ERR_UNKNOWN_ATTR, NC_ERR_MISSING_ELEM,   NC_ERR_BAD_ELEM, NC_ERR_UNKNOWN_ELEM, NC_ERR_UNKNOWN_NS, NC_ERR_ACCESS_DENIED,   NC_ERR_LOCK_DENIED, NC_ERR_RES_DENIED, NC_ERR_ROLLBACK_FAILED, NC_ERR_DATA_EXISTS,   NC_ERR_DATA_MISSING, NC_ERR_OP_NOT_SUPPORTED, NC_ERR_OP_FAILED, NC_ERR_MALFORMED_MSG }
	Enumeration of NETCONF errors. More...
enum	NC_ERROR_TYPE {   NC_ERR_TYPE_UNKNOWN = 0, NC_ERR_TYPE_TRAN, NC_ERR_TYPE_RPC, NC_ERR_TYPE_PROT,   NC_ERR_TYPE_APP }
	Enumeration of NETCONF error type (layer) More...

Functions
struct lyd_node *	nc_err (const struct ly_ctx *ctx, NC_ERR tag,...)
	Create a server error structure. Its <error-message> is filled with a general description of the specific error. More...
int	nc_err_add_bad_attr (struct lyd_node *err, const char *attr_name)
	Add a <bad-attribute> element to an error. More...
int	nc_err_add_bad_elem (struct lyd_node *err, const char *elem_name)
	Add a <bad-element> element to an error. More...
int	nc_err_add_bad_ns (struct lyd_node *err, const char *ns_name)
	Add a <bad-namespace> element to an error. More...
int	nc_err_add_info_other (struct lyd_node *err, struct lyd_node *other)
	Add an additional custom element to an error. More...
const char *	nc_err_get_app_tag (const struct lyd_node *err)
	Get the <error-app-tag> of a server error. More...
const char *	nc_err_get_msg (const struct lyd_node *err)
	Get the <error-message> of a server error. More...
const char *	nc_err_get_path (const struct lyd_node *err)
	Get the <error-path> of a server error. More...
NC_ERR	nc_err_get_tag (const struct lyd_node *err)
	Get the <error-tag> of a server error. More...
NC_ERR_TYPE	nc_err_get_type (const struct lyd_node *err)
	Get the <error-type> of a server error. More...
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. More...
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. More...
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. More...
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. More...
void	nc_server_notif_free (struct nc_server_notif *notif)
	Free a server Event Notification object. More...
const char *	nc_server_notif_get_time (const struct nc_server_notif *notif)
	Get the notification timestamp. More...
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). More...
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. More...
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. More...
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. More...
struct nc_server_reply *	nc_server_reply_err (struct lyd_node *err)
	Create an ERROR rpc-reply object. More...
void	nc_server_reply_free (struct nc_server_reply *reply)
	Free a server rpc-reply object. More...
struct lyd_node *	nc_server_reply_get_last_err (const struct nc_server_reply *reply)
	Get last error from an ERROR rpc-reply object. More...
struct nc_server_reply *	nc_server_reply_ok (void)
	Create an OK rpc-reply object. More...

Detailed Description

libnetconf2's functions and structures of server NETCONF messages.

Author

Michal Vasko mvask.nosp@m.o@ce.nosp@m.snet..nosp@m.cz

Copyright

Copyright (c) 2015-2021 CESNET, z.s.p.o.

This source code is licensed under BSD 3-Clause License (the "License"). You may not use this file except in compliance with the License. You may obtain a copy of the License at

https://opensource.org/licenses/BSD-3-Clause

Definition in file messages_server.h.