messages_client.h File Reference

libnetconf2's public functions and structures of NETCONF client messages. More...

#include <stdint.h>
#include "netconf.h"

Go to the source code of this file.

Data Structures
struct	nc_err
	NETCONF error structure representation. More...
struct	nc_reply
	NETCONF client rpc-reply object. More...
struct	nc_reply_data
	NETCONF client data rpc-reply object. More...
struct	nc_reply_error
	NETCONF client error rpc-reply object. More...
struct	nc_notif
	NETCONF client notification object. More...

Enumerations
enum	NC_RPC_TYPE {   NC_RPC_UNKNOWN = 0, NC_RPC_ACT_GENERIC, NC_RPC_GETCONFIG, NC_RPC_EDIT,   NC_RPC_COPY, NC_RPC_DELETE, NC_RPC_LOCK, NC_RPC_UNLOCK,   NC_RPC_GET, NC_RPC_KILL, NC_RPC_COMMIT, NC_RPC_DISCARD,   NC_RPC_CANCEL, NC_RPC_VALIDATE, NC_RPC_GETSCHEMA, NC_RPC_SUBSCRIBE,   NC_RPC_GETDATA, NC_RPC_EDITDATA }
	Enumeration of RPC types. More...
enum	NC_RPC_EDIT_DFLTOP { NC_RPC_EDIT_DFLTOP_UNKNOWN = 0, NC_RPC_EDIT_DFLTOP_MERGE, NC_RPC_EDIT_DFLTOP_REPLACE, NC_RPC_EDIT_DFLTOP_NONE }
	Enumeration of <edit-config> default operation. More...
enum	NC_RPC_EDIT_TESTOPT { NC_RPC_EDIT_TESTOPT_UNKNOWN = 0, NC_RPC_EDIT_TESTOPT_TESTSET, NC_RPC_EDIT_TESTOPT_SET, NC_RPC_EDIT_TESTOPT_TEST }
	Enumeration of <edit-config> test option. More...
enum	NC_RPC_EDIT_ERROPT { NC_RPC_EDIT_ERROPT_UNKNOWN = 0, NC_RPC_EDIT_ERROPT_STOP, NC_RPC_EDIT_ERROPT_CONTINUE, NC_RPC_EDIT_ERROPT_ROLLBACK }
	Enumeration of <edit-config> error option. More...

Functions
NC_RPC_TYPE	nc_rpc_get_type (const struct nc_rpc *rpc)
	Get the type of the RPC. More...
struct nc_rpc *	nc_rpc_act_generic (const struct lyd_node *data, NC_PARAMTYPE paramtype)
	Create a generic NETCONF RPC or action. More...
struct nc_rpc *	nc_rpc_act_generic_xml (const char *xml_str, NC_PARAMTYPE paramtype)
	Create a generic NETCONF RPC or action from an XML string. More...
struct nc_rpc *	nc_rpc_getconfig (NC_DATASTORE source, const char *filter, NC_WD_MODE wd_mode, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <get-config> More...
struct nc_rpc *	nc_rpc_edit (NC_DATASTORE target, NC_RPC_EDIT_DFLTOP default_op, NC_RPC_EDIT_TESTOPT test_opt, NC_RPC_EDIT_ERROPT error_opt, const char *edit_content, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <edit-config> More...
struct nc_rpc *	nc_rpc_copy (NC_DATASTORE target, const char *url_trg, NC_DATASTORE source, const char *url_or_config_src, NC_WD_MODE wd_mode, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <copy-config> More...
struct nc_rpc *	nc_rpc_delete (NC_DATASTORE target, const char *url, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <delete-config> More...
struct nc_rpc *	nc_rpc_lock (NC_DATASTORE target)
	Create NETCONF RPC <lock> More...
struct nc_rpc *	nc_rpc_unlock (NC_DATASTORE target)
	Create NETCONF RPC <unlock> More...
struct nc_rpc *	nc_rpc_get (const char *filter, NC_WD_MODE wd_mode, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <get> More...
struct nc_rpc *	nc_rpc_kill (uint32_t session_id)
	Create NETCONF RPC <kill-session> More...
struct nc_rpc *	nc_rpc_commit (int confirmed, uint32_t confirm_timeout, const char *persist, const char *persist_id, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <commit> More...
struct nc_rpc *	nc_rpc_discard (void)
	Create NETCONF RPC <discard-changes> More...
struct nc_rpc *	nc_rpc_cancel (const char *persist_id, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <cancel-commit> More...
struct nc_rpc *	nc_rpc_validate (NC_DATASTORE source, const char *url_or_config, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <validate> More...
struct nc_rpc *	nc_rpc_getschema (const char *identifier, const char *version, const char *format, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <get-schema> More...
struct nc_rpc *	nc_rpc_subscribe (const char *stream_name, const char *filter, const char *start_time, const char *stop_time, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <create-subscription> More...
struct nc_rpc *	nc_rpc_getdata (const char *datastore, const char *filter, const char *config_filter, char **origin_filter, int origin_filter_count, int neg_origin_filter, uint16_t max_depth, int with_origin, NC_WD_MODE wd_mode, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <get-data> More...
struct nc_rpc *	nc_rpc_editdata (const char *datastore, NC_RPC_EDIT_DFLTOP default_op, const char *edit_content, NC_PARAMTYPE paramtype)
	Create NETCONF RPC <get-data> More...
void	nc_rpc_free (struct nc_rpc *rpc)
	Free the NETCONF RPC object. More...
void	nc_reply_free (struct nc_reply *reply)
	Free the NETCONF RPC reply object. More...
void	nc_notif_free (struct nc_notif *notif)
	Free the NETCONF Notification object. More...

Detailed Description

libnetconf2's public functions and structures of NETCONF client messages.

Author

Radek Krejci rkrej.nosp@m.ci@c.nosp@m.esnet.nosp@m..cz

Michal Vasko mvask.nosp@m.o@ce.nosp@m.snet..nosp@m.cz Copyright (c) 2015 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_client.h.