yumapro  20.10-12
YumaPro SDK
YumaPro Module Tag Filtering
Collaboration diagram for YumaPro Module Tag Filtering:

Functions

status_t agt_modtags_init (void)
 Initialize YumaPro module tags feature. More...
 
status_t agt_modtags_init2 (void)
 Initialize YumaPro module tags feature (phase 2) More...
 
void agt_modtags_cleanup (void)
 Cleanup the module static data. More...
 
status_t agt_modtags_setup_filter (xml_msg_hdr_t *msg, val_value_t *inputval, val_value_t **errval)
 Setup a modtag filter in the specified msg. More...
 
boolean agt_modtags_check_filter (xml_msg_hdr_t *msg, val_value_t *val)
 Check a modtag filter in the specified msg applies to the value. More...
 
void * agt_modtags_find_modtag (const xmlChar *tagstr)
 Find a modtag; return opaque pointer. More...
 
boolean agt_modtags_check_modtag (void *v_modtag, xmlns_id_t nsid)
 Check a modtag filter for NACM. More...
 

Detailed Description

YumaPro module tags implementation, if –with-modtags is true. The –with-yumaworks-system=true parameter is needed to use the <get-module-tags> operation.

Function Documentation

◆ agt_modtags_check_filter()

boolean agt_modtags_check_filter ( xml_msg_hdr_t *  msg,
val_value_t *  val 
)

Check a modtag filter in the specified msg applies to the value.

Check the namespace ID match

Parameters
msgrequest message in progress to check
valvalue node to check; only the namespace ID is used
Returns
TRUE if the modtag filters include this value node
FALSE if the modtag filters exclude this value node
Here is the call graph for this function:

◆ agt_modtags_check_modtag()

boolean agt_modtags_check_modtag ( void *  v_modtag,
xmlns_id_t  nsid 
)

Check a modtag filter for NACM.

Parameters
v_modtagmodtag cast as void *
nsidnamespace ID to check
Returns
TRUE if the namespace ID is included the filter
FALSE if the namespace ID is not included in the filter

◆ agt_modtags_cleanup()

void agt_modtags_cleanup ( void  )

Cleanup the module static data.

Called by the server during shutdown

Here is the call graph for this function:

◆ agt_modtags_find_modtag()

void* agt_modtags_find_modtag ( const xmlChar *  tagstr)

Find a modtag; return opaque pointer.

Parameters
tagstrmodule-tag value to find
Returns
modtag_t cast as void * or NULL if not found

◆ agt_modtags_init()

status_t agt_modtags_init ( void  )

Initialize YumaPro module tags feature.

Returns
NO_ERR if all goes well
Here is the call graph for this function:

◆ agt_modtags_init2()

status_t agt_modtags_init2 ( void  )

Initialize YumaPro module tags feature (phase 2)

Returns
NO_ERR if all goes well
Here is the call graph for this function:

◆ agt_modtags_setup_filter()

status_t agt_modtags_setup_filter ( xml_msg_hdr_t *  msg,
val_value_t *  inputval,
val_value_t **  errval 
)

Setup a modtag filter in the specified msg.

Parameters
msgretrieval request message in progress
inputvalmessage input value to check
errvaladdress or return error value
Return values
*errvalvalue to use in rpc-error if any errors
Returns
status
Here is the call graph for this function: