Value Node Types

Data types used to store YANG data values. More...

Collaboration diagram for Value Node Types:

Data Structures
struct	logfns_t
	log functions control block used by manager code More...
struct	val_idref_t
	one QName for the NCX_BT_IDREF value More...
struct	val_editvars_t
	one set of edit-in-progress variables for one value node More...
struct	val_extra_t
	extra information not used very often within a val_value_t More...
struct	val_value_t
	one value to match one type More...
struct	val_child_hdr_t
	this struct is inserted in the val->v.child_hdrQ for container and list value nodes More...
struct	val_index_t
	Struct marking the parsing of an instance identifier The position of this record in the val_value_t indexQ represents the order the identifers were parsed Since table and container data structures must always appear in the specified field order, this will be the same order for all well-formed entries. More...

Typedefs
typedef void(*	dumpfn_t) (log_debug_t level, const char *fstr,...)
	Callback to do log dump function for dump_value. More...
typedef void(*	errfn_t) (const char *fstr,...)
	Callback to do error log function for dump_value. More...
typedef void(*	indentfn_t) (log_debug_t level, int32 indentcnt)
	Callback to do indent function for dump_value. More...
typedef boolean(*	val_test_fn_t) (const val_value_t *val)
	test callback function to check if a value node should be cloned More...
typedef boolean(*	val_walker_fn_t) (val_value_t *val, void *cookie1, void *cookie2)
	child or descendant node search walker function More...
typedef boolean(*	val_walker2_fn_t) (val_child_hdr_t *valhdr, void *cookie1, void *cookie2)
	child or descendant node search walker function - GEN2 More...
typedef boolean(*	val_hdr_test_fn_t) (val_child_hdr_t *hdr, void *cookie)
	get first or next child test function header test function More...
typedef boolean(*	val_test2_fn_t) (val_value_t *val, void *cookie)
	get first or next child test function value test function More...

Enumerations
enum	val_insert_mode_t {   VAL_INS_MODE_NONE ,   VAL_INS_MODE_KEY ,   VAL_INS_MODE_VALUE ,   VAL_INS_MODE_POINT }
	type of protocol parameter used for insert operation More...
enum	val_dumpvalue_mode_t {   DUMP_VAL_NONE ,   DUMP_VAL_STDOUT ,   DUMP_VAL_LOG ,   DUMP_VAL_ALT_LOG ,   DUMP_VAL_AUDIT_LOG }
	dump value mode used in val_dump_value More...

Detailed Description

Data types used to store YANG data values.

A val_value_t tree represents a YANG subtree.

Typedef Documentation

dumpfn_t

typedef void(* dumpfn_t) (log_debug_t level, const char *fstr,...)

Callback to do log dump function for dump_value.

Parameters

level	debug level to use
fstr	format string
...	extra parameters based on fstr

errfn_t

typedef void(* errfn_t) (const char *fstr,...)

Callback to do error log function for dump_value.

Parameters

fstr	format string
...	extra parameters based on fstr

indentfn_t

typedef void(* indentfn_t) (log_debug_t level, int32 indentcnt)

Callback to do indent function for dump_value.

Parameters

level	debug level to use
indentcnt	indent amout (expect 1 .. 9)

val_hdr_test_fn_t

typedef boolean(* val_hdr_test_fn_t) (val_child_hdr_t *hdr, void *cookie)

get first or next child test function header test function

Parameters

hdr	value header node to test
cookie	opaque pointer passed to walker function

Returns

TRUE if node passes test and should be processed
FALSE if node does not pass test and should be skipped

val_test2_fn_t

typedef boolean(* val_test2_fn_t) (val_value_t *val, void *cookie)

get first or next child test function value test function

Parameters

val	value node to test
cookie	opaque pointer passed to walker function

Returns

TRUE if node passes test and should be processed
FALSE if node does not pass test and should be skipped

val_test_fn_t

typedef boolean(* val_test_fn_t) (const val_value_t *val)

test callback function to check if a value node should be cloned

Parameters

val	value node to check

Returns

TRUE if OK to be cloned
FALSE if not OK to be cloned (skipped instead)

val_walker2_fn_t

typedef boolean(* val_walker2_fn_t) (val_child_hdr_t *valhdr, void *cookie1, void *cookie2)

child or descendant node search walker function - GEN2

Parameters

valhdr	value header node found in descendant search
cookie1	cookie1 value passed to start of walk
cookie2	cookie2 value passed to start of walk

Returns

TRUE if walk should continue
FALSE if walk should terminate

val_walker_fn_t

typedef boolean(* val_walker_fn_t) (val_value_t *val, void *cookie1, void *cookie2)

child or descendant node search walker function

Parameters

val	value node found in descendant search
cookie1	cookie1 value passed to start of walk
cookie2	cookie2 value passed to start of walk

Returns

TRUE if walk should continue
FALSE if walk should terminate

Enumeration Type Documentation

val_dumpvalue_mode_t

enum val_dumpvalue_mode_t

dump value mode used in val_dump_value

Enumerator
DUMP_VAL_NONE	not set
DUMP_VAL_STDOUT	dump val to STDOUT
DUMP_VAL_LOG	dump val to main log
DUMP_VAL_ALT_LOG	dump val to alternate log
DUMP_VAL_AUDIT_LOG	dump val to audit log

val_insert_mode_t

enum val_insert_mode_t

type of protocol parameter used for insert operation

Enumerator
VAL_INS_MODE_NONE	not set
VAL_INS_MODE_KEY	YANG key attribute.
VAL_INS_MODE_VALUE	YANG value attribute.
VAL_INS_MODE_POINT	YANG-API point param.