yumapro  20.10-14
YumaPro SDK
Get Bulk Support

Supports the NETCONF <get-bulk> operation. More...

Collaboration diagram for Get Bulk Support:

Data Structures

struct  getbulk_cb_t
 Get Bulk Control BLock. More...
 

Functions

getbulk_cb_tgetbulk_new_cb (void)
 Create a new getbulk control block. More...
 
void getbulk_free_cb (getbulk_cb_t *cb)
 Clean and free a getbulk control block. More...
 
status_t getbulk_check_get2 (getbulk_cb_t *bulk, obj_template_t *obj, uint32 *max_entries, val_value_t **last_entry)
 Check the GET2 object against the getbulk request to see if it needs to be processed as get-bulk or normal. More...
 
boolean getbulk_with_get2 (getbulk_cb_t *bulk, obj_template_t *obj)
 Check the GET2 object against the getbulk request to see if it needs to be processed as get-bulk or normal. More...
 
status_t getbulk_create_last_keys (getbulk_cb_t *bulk, val_value_t *lastval)
 Create the <last-keys> container and clone the keys from the lastval. More...
 
status_t getbulk_create_last_keys_get2 (getbulk_cb_t *bulk, dlq_hdr_t *keyQ)
 Create the <last-keys> container and clone the keys from the lastval; For GET2 callback. More...
 

Detailed Description

Supports the NETCONF <get-bulk> operation.

Defines the Get Bulk Control Block and utilties to manage this CB. Also utilities to convert to/from val_value_t to use within SIL or SIL-SA code and between subsystem and server.

Function Documentation

◆ getbulk_check_get2()

status_t getbulk_check_get2 ( getbulk_cb_t bulk,
obj_template_t obj,
uint32 *  max_entries,
val_value_t **  last_entry 
)

Check the GET2 object against the getbulk request to see if it needs to be processed as get-bulk or normal.

Parameters
bulkgetbulk control block to check
objobject being processed by getcb GET2
max_entriesaddress of return 'count'
last_entryaddress of return last_entry struct
Return values
*max_entriesvalue of 'count' if get-bulk needed
*last_entryvalue struct containing keys to use for GETNEXT
Returns
status; ERR_NCX_SKIPPED if not used;

◆ getbulk_create_last_keys()

status_t getbulk_create_last_keys ( getbulk_cb_t bulk,
val_value_t lastval 
)

Create the <last-keys> container and clone the keys from the lastval.

Parameters
bulkgetbulk control block to use
lastvalvalue to use for keys
Return values
bulk->ret_last_keysis set
Returns
status
Here is the call graph for this function:

◆ getbulk_create_last_keys_get2()

status_t getbulk_create_last_keys_get2 ( getbulk_cb_t bulk,
dlq_hdr_t *  keyQ 
)

Create the <last-keys> container and clone the keys from the lastval; For GET2 callback.

Parameters
bulkgetbulk control block to use
keyQQ of leaf values to use for keys
Return values
bulk->ret_last_keysis set
Returns
status

◆ getbulk_free_cb()

void getbulk_free_cb ( getbulk_cb_t cb)

Clean and free a getbulk control block.

Parameters
cbgetbulk control block to clean and free
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getbulk_new_cb()

getbulk_cb_t* getbulk_new_cb ( void  )

Create a new getbulk control block.

Returns
malloced new getbulk control block that must be freed later

◆ getbulk_with_get2()

boolean getbulk_with_get2 ( getbulk_cb_t bulk,
obj_template_t obj 
)

Check the GET2 object against the getbulk request to see if it needs to be processed as get-bulk or normal.

Parameters
bulkgetbulk control block to check
objobject being processed by getcb GET2
Returns
TRUE id getbulk active for this object