Search a YANG Module

Search functions for the ncx_module_t_ structure Find top-level constructs like rpc, data, notifications. More...

Collaboration diagram for Search a YANG Module:

Functions
obj_template_t *	ncx_match_rpc (ncx_module_t *mod, const xmlChar *rpcname, uint32 *retcount)
	Check if a rpc_template_t in the mod->rpcQ. More...
typ_template_t *	ncx_find_type (ncx_module_t *mod, const xmlChar *typname, boolean useall)
	Check if a typ_template_t in the mod->typeQ. More...
typ_template_t *	ncx_find_type_que (const dlq_hdr_t *typeQ, const xmlChar *typname)
	ncx_find_type_que More...
grp_template_t *	ncx_find_grouping (ncx_module_t *mod, const xmlChar *grpname, boolean useall)
	Find the YANG grouping. More...
grp_template_t *	ncx_find_grouping_que (const dlq_hdr_t *groupingQ, const xmlChar *grpname)
	Check if a grp_template_t in the specified Q. More...
obj_template_t *	ncx_find_rpc (const ncx_module_t *mod, const xmlChar *rpcname)
	Check if a rpc_template_t in the mod->rpcQ. More...
obj_template_t *	ncx_match_any_rpc_mod (ncx_module_t *mod, const xmlChar *rpcname, uint32 *retcount)
	Check if a rpc_template_t is in the specified module. More...
obj_template_t *	ncx_get_first_data_object (ncx_module_t *mod)
	Get the first datastore object in the module. More...
obj_template_t *	ncx_find_next_data_object (ncx_module_t *mod, obj_template_t *obj)
	Check the next obj_template_t in in any module that matches the object name string. More...
obj_template_t *	ncx_find_object (ncx_module_t *mod, const xmlChar *objname)
	Find a top level module object. More...
obj_template_t *	ncx_find_object_nsid (xmlns_id_t nsid, const xmlChar *objname)
	Find a top level module object by module NSID. More...
obj_template_t *	ncx_get_first_object (ncx_module_t *mod)
	Get the first object in the datadefQs for the specified module. More...
obj_template_t *	ncx_get_first_object_ex (ncx_module_t *mod, boolean augment_ok)
	Get the first object in the datadefQs for the specified module. More...
obj_template_t *	ncx_get_last_object (ncx_module_t *mod, boolean augment_ok)
	Find the last data node. More...
obj_template_t *	ncx_get_next_object (ncx_module_t *mod, obj_template_t *curobj)
	Get the next object in the specified module. More...
obj_template_t *	ncx_get_next_object_ex (ncx_module_t *mod, obj_template_t *curobj, boolean augment_ok)
	Get the next object in the specified module. More...
obj_template_t *	ncx_get_prev_object (ncx_module_t *mod, obj_template_t *curobj, boolean augment_ok)
	Find the previous object node. More...
obj_template_t *	ncx_get_next_data_object (ncx_module_t *mod, obj_template_t *curobj)
	Get the next database object in the specified module. More...
obj_template_t *	ncx_get_first_data_object_pick (ncx_module_t *mod, boolean config)
	Get the first database object in the datadefQs for the specified module. More...
obj_template_t *	ncx_get_next_data_object_same (ncx_module_t *mod, obj_template_t *curobj)
	Get the next database object in the specified module. More...

Detailed Description

Search functions for the ncx_module_t_ structure Find top-level constructs like rpc, data, notifications.

Function Documentation

ncx_find_grouping()

grp_template_t * ncx_find_grouping	(	ncx_module_t *	mod,
		const xmlChar *	grpname,
		boolean	useall
	)

Find the YANG grouping.

Check if a grp_template_t in the mod->groupingQ. Check mod for the grouping called grpname. Use useall to check all submodules, but Not needed if submodules have been collaped.

Parameters

mod	ncx_module to check
grpname	group name
useall	TRUE to check all existing nodes FALSE to only use includes visible to this [sub]mod

Returns

pointer to struct if present, NULL otherwise

See also

ncx_find_grouping_ex

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_find_grouping_que()

grp_template_t * ncx_find_grouping_que	(	const dlq_hdr_t *	groupingQ,
		const xmlChar *	grpname
	)

Check if a grp_template_t in the specified Q.

Parameters

groupingQ	Queue of grp_template_t to check
grpname	group name

Returns

pointer to struct if present, NULL otherwise

See also

ncx_find_grouping

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_find_next_data_object()

obj_template_t * ncx_find_next_data_object	(	ncx_module_t *	mod,
		obj_template_t *	obj
	)

Check the next obj_template_t in in any module that matches the object name string.

Parameters

mod	current module
obj	current object in curmod

Returns

pointer to struct if present, NULL otherwise

See also

ncx_get_first_data_object

Here is the call graph for this function:

ncx_find_object()

obj_template_t * ncx_find_object	(	ncx_module_t *	mod,
		const xmlChar *	objname
	)

Find a top level module object.

Parameters

mod	ncx_module to check
objname	object name to find

Returns

pointer to struct if present, NULL otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_find_object_nsid()

obj_template_t * ncx_find_object_nsid	(	xmlns_id_t	nsid,
		const xmlChar *	objname
	)

Find a top level module object by module NSID.

Parameters

nsid	namespace ID to check
objname	object name

Returns

pointer to struct if present, NULL otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_find_rpc()

obj_template_t * ncx_find_rpc	(	const ncx_module_t *	mod,
		const xmlChar *	rpcname
	)

Check if a rpc_template_t in the mod->rpcQ.

Parameters

mod	ncx_module to check
rpcname	RPC name to find

Returns

pointer to struct if present, NULL otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_find_type()

typ_template_t * ncx_find_type	(	ncx_module_t *	mod,
		const xmlChar *	typname,
		boolean	useall
	)

Check if a typ_template_t in the mod->typeQ.

Check mod for the typedef called typname. Use useall to check all submodules, but Not needed if submodules have been collaped.

Parameters

mod	ncx_module to check
typname	type name to find
useall	TRUE to use all submodules; FALSE to only use the ones in the mod->includeQ

Returns

pointer to struct if present, NULL otherwise

See also

ncx_find_type_ex

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_find_type_que()

typ_template_t * ncx_find_type_que	(	const dlq_hdr_t *	typeQ,
		const xmlChar *	typname
	)

ncx_find_type_que

Check if a typ_template_t in the specified Q of typ_template_t_ Usually this is the mod->typeQ queue

Parameters

typeQ	type Q to check
typname	type name to find

Returns

pointer to struct if present, NULL otherwise

See also

ncx_find_type

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_get_first_data_object()

obj_template_t * ncx_get_first_data_object

(

ncx_module_t *

mod

)

Get the first datastore object in the module.

Get the first database object in the datadefQs for the specified module

Parameters

mod	module to search for the first object

Returns

pointer to the first object or NULL if empty Q

See also

ncx_get_next_data_object

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_get_first_data_object_pick()

obj_template_t * ncx_get_first_data_object_pick	(	ncx_module_t *	mod,
		boolean	config
	)

Get the first database object in the datadefQs for the specified module.

Parameters

mod	module to search for the first object
config	TRUE for config node FALSE for non-config

Returns

pointer to the first object or NULL if empty Q

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_get_first_object()

obj_template_t * ncx_get_first_object

(

ncx_module_t *

mod

)

Get the first object in the datadefQs for the specified module.

Get any object with a name

Parameters

mod	module to search for the first object

Returns

pointer to the first object or NULL if empty Q

See also

ncx_get_next_object

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_get_first_object_ex()

obj_template_t * ncx_get_first_object_ex	(	ncx_module_t *	mod,
		boolean	augment_ok
	)

Get the first object in the datadefQs for the specified module.

Get any object with a name

Parameters

mod	module to search for the first object
augment_ok	TRUE if return augment objects

Returns

pointer to the first object or NULL if empty Q

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_get_last_object()

obj_template_t * ncx_get_last_object	(	ncx_module_t *	mod,
		boolean	augment_ok
	)

Find the last data node.

Get the last object in the datadefQs for the specified module Get any object with a name

Parameters

mod	module to search for the first object
augment_ok	TRUE if return augment objects

Returns

pointer to struct if present, NULL otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_get_next_data_object()

obj_template_t * ncx_get_next_data_object	(	ncx_module_t *	mod,
		obj_template_t *	curobj
	)

Get the next database object in the specified module.

Parameters

mod	pointer to module to get object from
curobj	pointer to current object to get next from

Returns

pointer to the next object or NULL if none

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_get_next_data_object_same()

obj_template_t * ncx_get_next_data_object_same	(	ncx_module_t *	mod,
		obj_template_t *	curobj
	)

Get the next database object in the specified module.

Only get the same type of object as specified (config or non-config)

Parameters

mod	pointer to module to get object from
curobj	pointer to current object to get next from

Returns

pointer to the next object or NULL if none

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_get_next_object()

obj_template_t * ncx_get_next_object	(	ncx_module_t *	mod,
		obj_template_t *	curobj
	)

Get the next object in the specified module.

Get any object with a name

Parameters

mod	module struct to get the next object from
curobj	pointer to the current object to get the next for

Returns

pointer to the next object or NULL if none

See also

ncx_get_first_object

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_get_next_object_ex()

obj_template_t * ncx_get_next_object_ex	(	ncx_module_t *	mod,
		obj_template_t *	curobj,
		boolean	augment_ok
	)

Get the next object in the specified module.

Get any object with a name Not used by netconfd!!! Will only check top-level database objects if ncx_moveroot_enabled true!!

Parameters

mod	module struct to get the next object from
curobj	pointer to the current object to get the next for
augment_ok	TRUE to include augment objects

Returns

pointer to the next object or NULL if none

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_get_prev_object()

obj_template_t * ncx_get_prev_object	(	ncx_module_t *	mod,
		obj_template_t *	curobj,
		boolean	augment_ok
	)

Find the previous object node.

Get the previous object in the specified module Get any object with a name

Parameters

mod	module struct to get the next object from
curobj	pointer to the current object to get the next for
augment_ok	TRUE to include augment objects

Returns

pointer to struct if present, NULL otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_match_any_rpc_mod()

obj_template_t * ncx_match_any_rpc_mod	(	ncx_module_t *	mod,
		const xmlChar *	rpcname,
		uint32 *	retcount
	)

Check if a rpc_template_t is in the specified module.

Parameters

	mod	module struct to check
	rpcname	RPC name to match
[out]	retcount	address of return count of matches *retcount number of matches found

Returns

pointer to struct if present, NULL otherwise

Here is the call graph for this function:

ncx_match_rpc()

obj_template_t * ncx_match_rpc	(	ncx_module_t *	mod,
		const xmlChar *	rpcname,
		uint32 *	retcount
	)

Check if a rpc_template_t in the mod->rpcQ.

Parameters

	mod	ncx_module to check
	rpcname	RPC name to match
[out]	retcount	address of return match count *retcount number of matches found

Returns

pointer to struct if present, NULL otherwise

Here is the call graph for this function:

Here is the caller graph for this function: