yumapro  20.10-13
YumaPro SDK
Collaboration diagram for YANG Object Types:

Data Structures

struct  obj_key_t_
 One YANG list key component. More...
 
struct  obj_defval_tk_t_
 One YANG 1.1 default stored in a Q for refine and deviate. More...
 
struct  obj_unique_comp_t_
 One component in a YANG list unique target. More...
 
struct  obj_unique_t_
 One component in a YANG list unique target. More...
 
struct  obj_container_t_
 One YANG 'container' definition. More...
 
struct  obj_leaf_t_
 One YANG 'leaf' or 'anyxml' or 'anydata' definition. More...
 
struct  obj_leaflist_t_
 One YANG 'leaf-list' definition. More...
 
struct  obj_list_t_
 One YANG 'list' definition. More...
 
struct  obj_choice_t_
 One YANG 'choice' definition. More...
 
struct  obj_case_t_
 One YANG 'case' definition. More...
 
struct  obj_uses_t_
 One YANG uses statement struct. More...
 
struct  obj_refine_t_
 One YANG refine statement struct. More...
 
struct  obj_rpcio_t_
 One YANG input-stmt or output-stmt struct. More...
 
struct  obj_rpc_t_
 One YANG rpc-stmt struct. More...
 
struct  obj_augment_t_
 One YANG augment statement struct (top-level or in case-stmt. More...
 
struct  obj_notif_t_
 One YANG 'notification' clause definition. More...
 
struct  obj_iffeature_ptr_t_
 back-pointer to inherited if-feature statements More...
 
struct  obj_errmsg_filter_t_
 custom error message filter control block More...
 
struct  obj_errmsg_parm_t_
 custom error message parameter control block More...
 
struct  obj_errmsg_t_
 custom error message control block More...
 
struct  obj_oid_t_
 defines the snmp oid value, stored as an array of integers for easier comparision when performing AVL tree operations. More...
 
struct  obj_template_t_
 One YANG data-def-stmt. More...
 
struct  obj_metadata_t_
 One YANG metadata (XML attribute) node. More...
 
struct  obj_deviate_t_
 YANG deviate statement struct. More...
 
struct  obj_deviation_t_
 YANG deviation statement struct. More...
 

Typedefs

typedef uint16 obj_index_t
 object index only applies to child nodes; this is assigned at runtime and any augments loaded at run-time are added at the end; used to sort val->v.complexQ faster by comparing a uint16 instead of a string
 
typedef unsigned long oid_t
 data type used in SNMP
 
typedef uint8 obj_testflags_t
 object test flags
 
typedef boolean(* obj_walker_fn_t) (obj_template_t *obj, void *cookie1, void *cookie2, boolean nonconfig_warn)
 child or descendant node search walker function More...
 

Enumerations

enum  obj_type_t_ {
  OBJ_TYP_NONE,
  OBJ_TYP_ANYXML,
  OBJ_TYP_CONTAINER,
  OBJ_TYP_LEAF,
  OBJ_TYP_LEAF_LIST,
  OBJ_TYP_LIST,
  OBJ_TYP_CHOICE,
  OBJ_TYP_CASE,
  OBJ_TYP_USES,
  OBJ_TYP_REFINE,
  OBJ_TYP_AUGMENT,
  OBJ_TYP_RPC,
  OBJ_TYP_RPCIO,
  OBJ_TYP_NOTIF,
  OBJ_TYP_ANYDATA,
  OBJ_TYP_ACTION
}
 enumeration for different YANG data def statement types the enum order is significant!!! do not change!!! More...
 
enum  obj_augtype_t_ {
  OBJ_AUGTYP_NONE,
  OBJ_AUGTYP_RPCIN,
  OBJ_AUGTYP_RPCOUT,
  OBJ_AUGTYP_CASE,
  OBJ_AUGTYP_DATA
}
 enumeration for different YANG augment statement types More...
 
enum  obj_deviate_arg_t_ {
  OBJ_DARG_NONE,
  OBJ_DARG_ADD,
  OBJ_DARG_DELETE,
  OBJ_DARG_REPLACE,
  OBJ_DARG_NOT_SUPPORTED
}
 type of deviation for each deviate entry More...
 

Detailed Description

The YANG object template is used to represent every possible YANG data definition construct. These structures are used by the compiler, client and server to use the YANG data, RPC operations, and notification messages.

Typedef Documentation

◆ obj_walker_fn_t

typedef boolean(* obj_walker_fn_t) (obj_template_t *obj, void *cookie1, void *cookie2, boolean nonconfig_warn)

child or descendant node search walker function

Parameters
objobject node found in descendant search
cookie1cookie1 value passed to start of walk
cookie2cookie2 value passed to start of walk
nonconfig_warnTRUE if nonconfig warning needed
Returns
TRUE if walk should continue; FALSE if walk should terminate

Enumeration Type Documentation

◆ obj_augtype_t_

enumeration for different YANG augment statement types

Enumerator
OBJ_AUGTYP_NONE 

not set

OBJ_AUGTYP_RPCIN 

rpc input

OBJ_AUGTYP_RPCOUT 

rpc output

OBJ_AUGTYP_CASE 

case

OBJ_AUGTYP_DATA 

within data

◆ obj_deviate_arg_t_

type of deviation for each deviate entry

Enumerator
OBJ_DARG_NONE 

not set

OBJ_DARG_ADD 

deviate add

OBJ_DARG_DELETE 

deviate delete

OBJ_DARG_REPLACE 

deviate replace

OBJ_DARG_NOT_SUPPORTED 

deviate not-supported

◆ obj_type_t_

enumeration for different YANG data def statement types the enum order is significant!!! do not change!!!

Enumerator
OBJ_TYP_NONE 

not set

OBJ_TYP_ANYXML 

anyxml

OBJ_TYP_CONTAINER 

container

OBJ_TYP_LEAF 

leaf

OBJ_TYP_LEAF_LIST 

leaf-list

OBJ_TYP_LIST 

list: last real database object

OBJ_TYP_CHOICE 

choice

OBJ_TYP_CASE 

case: last named database object

OBJ_TYP_USES 

uses-stmt has no name

OBJ_TYP_REFINE 

refine, child of uses only

OBJ_TYP_AUGMENT 

augment, used at top or inside obj

OBJ_TYP_RPC 

rpc-stmt

OBJ_TYP_RPCIO 

rpc input or output

OBJ_TYP_NOTIF 

notification

OBJ_TYP_ANYDATA 

anydata: YANG 1.1 only

OBJ_TYP_ACTION 

not really data, YANG 1.1 only