yumapro  20.10-14
YumaPro SDK
NMDA Support

Make sure to include "ncx_nmda.h" and "ncx_owner.h" to use the ncx_owner APIs. More...

Collaboration diagram for NMDA Support:

Functions

ncx_origin_filter_tncx_nmda_new_origin_filter (ncx_nmda_origin_t origin)
 Malloc a new ncx_origin_filter_t. More...
 
void ncx_nmda_free_origin_filter (ncx_origin_filter_t *filter)
 Free a ncx_origin_filter_t struct. More...
 
void ncx_nmda_clean_origin_filterQ (dlq_hdr_t *filterQ)
 Clean a Queue of ncx_origin_filter_t structs. More...
 
ncx_nmda_params_tncx_nmda_new_params (void)
 Malloc a new ncx_nmda_params_t. More...
 
void ncx_nmda_free_params (ncx_nmda_params_t *params)
 Free a ncx_nmda_params_t struct. More...
 
ncx_nmda_ds_t ncx_nmda_get_ds_enum (const xmlChar *ds_name)
 Get the standard datastore enum for the string. More...
 
const xmlChar * ncx_nmda_get_ds_str (ncx_nmda_ds_t ds_enum)
 Get the standard datastore string for the enum. More...
 
const xmlChar * ncx_nmda_get_full_ds_str (ncx_nmda_ds_t ds_enum)
 Get the standard datastore string for the enum using the ds: prefix. More...
 
ncx_nmda_ds_t ncx_nmda_get_dsref_parm (val_value_t *parmval)
 Handle the ds:datastore-ref data type parameter Extract the internal enum for the datastore. More...
 
ncx_cfg_t ncx_nmda_get_cfg_id (ncx_nmda_ds_t ds_enum)
 Get the cfg datastore ID for the NMDA datastore ID. More...
 
ncx_nmda_origin_t ncx_nmda_get_originref_parm (val_value_t *parmval)
 Handle the or:origin-ref data type parameter Extract the internal enum for the origin. More...
 
ncx_nmda_origin_t ncx_nmda_get_origin_enum (const xmlChar *or_name)
 Get the standard origin enum for the string. More...
 
const xmlChar * ncx_nmda_get_origin_str (ncx_nmda_origin_t or_enum)
 Get the standard origin string for the enum. More...
 
boolean ncx_nmda_ds_writable (ncx_nmda_ds_t ds_enum)
 Return TRUE if the datastore is writable by a client. More...
 
boolean ncx_nmda_ds_conventional (ncx_nmda_ds_t ds_enum)
 Return TRUE if the datastore is a conventional datastore which has config=true objects only. More...
 
status_t ncx_nmda_load_modules (dlq_hdr_t *devQ)
 Load the ietf-datastore and ietf-origin modules. More...
 
void ncx_owner_init (void)
 Initialize the Owner registry. More...
 
void ncx_owner_cleanup (void)
 Cleanup the Owner registry. More...
 
status_t ncx_owner_store_name (const xmlChar *name, ncx_owner_id_t *id)
 Add an owner name to the registry; return the ID,. More...
 
const xmlChar * ncx_owner_get_name (ncx_owner_id_t id)
 Find an owner name to the registry. More...
 

Detailed Description

Make sure to include "ncx_nmda.h" and "ncx_owner.h" to use the ncx_owner APIs.

Function Documentation

◆ ncx_nmda_clean_origin_filterQ()

void ncx_nmda_clean_origin_filterQ ( dlq_hdr_t *  filterQ)

Clean a Queue of ncx_origin_filter_t structs.

Parameters
filterQQ of ncx_origin_filter_t structs to free
Here is the caller graph for this function:

◆ ncx_nmda_ds_conventional()

boolean ncx_nmda_ds_conventional ( ncx_nmda_ds_t  ds_enum)

Return TRUE if the datastore is a conventional datastore which has config=true objects only.

Parameters
ds_enumdatastore name enum
Returns
TRUE if defined conventional; FALSE if not

◆ ncx_nmda_ds_writable()

boolean ncx_nmda_ds_writable ( ncx_nmda_ds_t  ds_enum)

Return TRUE if the datastore is writable by a client.

Parameters
ds_enumdatastore name enum
Returns
TRUE if defined allowed to write; FALSE if defined read-only

◆ ncx_nmda_free_origin_filter()

void ncx_nmda_free_origin_filter ( ncx_origin_filter_t filter)

Free a ncx_origin_filter_t struct.

Parameters
filterstruct to free

◆ ncx_nmda_free_params()

void ncx_nmda_free_params ( ncx_nmda_params_t params)

Free a ncx_nmda_params_t struct.

Parameters
paramsstruct to free
Here is the call graph for this function:
Here is the caller graph for this function:

◆ ncx_nmda_get_cfg_id()

ncx_cfg_t ncx_nmda_get_cfg_id ( ncx_nmda_ds_t  ds_enum)

Get the cfg datastore ID for the NMDA datastore ID.

Parameters
ds_enumenum value for the datastore
Returns
cfg enum value for the datastore
Here is the caller graph for this function:

◆ ncx_nmda_get_ds_enum()

ncx_nmda_ds_t ncx_nmda_get_ds_enum ( const xmlChar *  ds_name)

Get the standard datastore enum for the string.

Parameters
ds_namedatastore name with no prefix
Returns
datastore enum
Here is the call graph for this function:

◆ ncx_nmda_get_ds_str()

const xmlChar* ncx_nmda_get_ds_str ( ncx_nmda_ds_t  ds_enum)

Get the standard datastore string for the enum.

Parameters
ds_enumdatastore name enum
Returns
datastore name with no prefix or 'none' if no match

◆ ncx_nmda_get_dsref_parm()

ncx_nmda_ds_t ncx_nmda_get_dsref_parm ( val_value_t parmval)

Handle the ds:datastore-ref data type parameter Extract the internal enum for the datastore.

Parameters
parmvalparameter with type ds:datastore-ref
Returns
the ncx_nmda_ds_t enum or NCX_NMDA_DS_NONE if no match
Here is the call graph for this function:

◆ ncx_nmda_get_full_ds_str()

const xmlChar* ncx_nmda_get_full_ds_str ( ncx_nmda_ds_t  ds_enum)

Get the standard datastore string for the enum using the ds: prefix.

Parameters
ds_enumdatastore name enum
Returns
datastore name with no prefix or 'none' if no match

◆ ncx_nmda_get_origin_enum()

ncx_nmda_origin_t ncx_nmda_get_origin_enum ( const xmlChar *  or_name)

Get the standard origin enum for the string.

Parameters
or_nameorigin name with no prefix
Returns
origin enum
Here is the call graph for this function:

◆ ncx_nmda_get_origin_str()

const xmlChar* ncx_nmda_get_origin_str ( ncx_nmda_origin_t  or_enum)

Get the standard origin string for the enum.

Parameters
or_enumorigin name enum
Returns
origin name with no prefix or 'none' if no match

◆ ncx_nmda_get_originref_parm()

ncx_nmda_origin_t ncx_nmda_get_originref_parm ( val_value_t parmval)

Handle the or:origin-ref data type parameter Extract the internal enum for the origin.

Parameters
parmvalparameter with type or:origin-ref
Returns
the ncx_nmda_origin_t enum or NCX_NMDA_DS_NONE if no match
Here is the call graph for this function:

◆ ncx_nmda_load_modules()

status_t ncx_nmda_load_modules ( dlq_hdr_t *  devQ)

Load the ietf-datastore and ietf-origin modules.

Parameters
devQQ of ncx_save_deviations_t to use (may be NULL)
Returns
status
Here is the caller graph for this function:

◆ ncx_nmda_new_origin_filter()

ncx_origin_filter_t* ncx_nmda_new_origin_filter ( ncx_nmda_origin_t  origin)

Malloc a new ncx_origin_filter_t.

Parameters
originorigin enum to store
Returns
malloced struct

◆ ncx_nmda_new_params()

ncx_nmda_params_t* ncx_nmda_new_params ( void  )

Malloc a new ncx_nmda_params_t.

Returns
malloced struct
Here is the call graph for this function:
Here is the caller graph for this function:

◆ ncx_owner_cleanup()

void ncx_owner_cleanup ( void  )

Cleanup the Owner registry.

Here is the call graph for this function:

◆ ncx_owner_get_name()

const xmlChar* ncx_owner_get_name ( ncx_owner_id_t  id)

Find an owner name to the registry.

Parameters
idowner ID to find
Returns
name string or NULL if none
Here is the caller graph for this function:

◆ ncx_owner_init()

void ncx_owner_init ( void  )

Initialize the Owner registry.

Here is the call graph for this function:

◆ ncx_owner_store_name()

status_t ncx_owner_store_name ( const xmlChar *  name,
ncx_owner_id_t id 
)

Add an owner name to the registry; return the ID,.

Parameters
nameowner name to save
idreturn address of ID assigned
Return values
*idowner ID assigned
Returns
status
Here is the call graph for this function: