XPath Filtering

XPath Filtering used by NETCONF and RESTCONF Operations. More...

Collaboration diagram for XPath Filtering:

Functions
status_t	agt_xpath_output_filter (ses_cb_t *scb, rpc_msg_t *msg, const cfg_template_t *cfg, boolean getop, int32 indent)
	Output an XPath filter. More...
status_t	agt_xpath_output_cvt_filter (ses_cb_t *scb, rpc_msg_t *msg, const cfg_template_t *cfg, xpath_pcb_t *pcb, boolean getop, int32 indent)
	Output an XPath filter converted from Subtree. More...
boolean	agt_xpath_test_filter (xml_msg_hdr_t *msghdr, ses_cb_t *scb, val_value_t *selectval, val_value_t *val)
	Test an XPath filter for a notification. More...

Detailed Description

XPath Filtering used by NETCONF and RESTCONF Operations.

Supports <get-config>, <get>, and <get-data> operations. Calls local and/or remote GET2 callbacks if needed to get the requested data

Function Documentation

agt_xpath_output_cvt_filter()

status_t agt_xpath_output_cvt_filter	(	ses_cb_t *	scb,
		rpc_msg_t *	msg,
		const cfg_template_t *	cfg,
		xpath_pcb_t *	pcb,
		boolean	getop,
		int32	indent
	)

Output an XPath filter converted from Subtree.

Evaluate the XPath filter against the specified config root, and output the result of the <get> or <get-config> operation to the specified session Source is a converted subtree filter!!

Parameters

scb	session control block
msg	rpc_msg_t in progress
cfg	config target to check against
pcb	XPath control block to use
getop	TRUE if this is a <get> and not a <get-config> The target is expected to be the <running> config, and all state data will be available for the filter output. FALSE if this is a <get-config> and only the specified target in available for filter output
indent	start indent amount

Returns

status

agt_xpath_output_filter()

status_t agt_xpath_output_filter	(	ses_cb_t *	scb,
		rpc_msg_t *	msg,
		const cfg_template_t *	cfg,
		boolean	getop,
		int32	indent
	)

Output an XPath filter.

Evaluate the XPath filter against the specified config root, and output the result of the <get> or <get-config> operation to the specified session

Parameters

scb	session control block
msg	rpc_msg_t in progress
cfg	config target to check against
getop	TRUE if this is a <get> and not a <get-config> The target is expected to be the <running> config, and all state data will be available for the filter output. FALSE if this is a <get-config> and only the specified target in available for filter output
indent	start indent amount

Returns

status

Here is the call graph for this function:

agt_xpath_test_filter()

boolean agt_xpath_test_filter	(	xml_msg_hdr_t *	msghdr,
		ses_cb_t *	scb,
		val_value_t *	selectval,
		val_value_t *	val
	)

Test an XPath filter for a notification.

Evaluate the XPath filter against the specified config root, and just test if there would be any <eventType> element generated at all

Does not write any output based on the XPath evaluation

Parameters

msghdr	message header in progress (for access control)
scb	session control block
selectval	filter value struct to use
val	top of value tree to compare the filter against !!! not written – not const in XPath in case !!! a set-by-xpath function ever implemented

Returns

TRUE if filter passed or FALSE if error or did not pass

Here is the call graph for this function: