yumapro  20.10-10
YumaPro SDK
RESTCONF Core Functions

RESTCONF Core Functions. More...

Collaboration diagram for RESTCONF Core Functions:

Functions

yangapi_param_tyangapi_new_param (const xmlChar *parmname, uint32 parmnamelen, const xmlChar *parmval, uint32 parmvallen)
 Create a new YANGAPI paramater. More...
 
void yangapi_free_param (yangapi_param_t *param)
 Free a YANG-API parameter. More...
 
yangapi_accept_tyangapi_new_accept (const xmlChar *mediatype, uint32 media_type_len, const xmlChar *submediatype, uint32 submediatype_len, const xmlChar *acc_format, uint32 acc_format_len, const xmlChar *qvalue, uint32 qvalue_len)
 Create a new YANGAPI paramater. More...
 
void yangapi_free_accept (yangapi_accept_t *accept_entry)
 Free a YANGAPI accept header entries. More...
 
void yangapi_clean_keyvalQ (yangapi_cb_t *rcb)
 Clean the key value Q in a request control block. More...
 
void yangapi_clean_getnext_listQ (yangapi_cb_t *rcb, ses_cb_t *scb)
 Free all the snmp getnext list entries. More...
 
void yangapi_clean_target_keyvalQ (yangapi_cb_t *rcb)
 Free all the snmp target keyval entries. More...
 
yangapi_cb_tyangapi_new_rcb (void)
 Create a new YANG-API control block. More...
 
void yangapi_free_rcb (yangapi_cb_t *rcb)
 Free a YANGAPI control block. More...
 
void yangapi_clean_rcb (yangapi_cb_t *rcb)
 Clean a YANGAPI/RESTCONF control block. More...
 
const xmlChar * yangapi_get_method_name (yangapi_method_t method_enum)
 Get the method name from its enum. More...
 
uint8 yangapi_cvt_method_coap (yangapi_method_t method_enum)
 Get the libcoap numeric value for the HTTP method enum. More...
 
restconf_content_t yangapi_get_content_enum (const xmlChar *content)
 Get the enum for the content query parameter from the query URI part. More...
 
const xmlChar * yangapi_get_content_name (restconf_content_t content)
 Get the keyword for the specified restconf_content_t enumeration. More...
 

Detailed Description

RESTCONF Core Functions.

Function Documentation

void yangapi_clean_getnext_listQ ( yangapi_cb_t rcb,
ses_cb_t scb 
)

Free all the snmp getnext list entries.

Parameters
rcbcontrol block to use
scbcontrol block to use

Here is the call graph for this function:

Here is the caller graph for this function:

void yangapi_clean_keyvalQ ( yangapi_cb_t rcb)

Clean the key value Q in a request control block.

Free all the GET2 keyvals in a queue

Parameters
rcbcontrol block to use

Here is the call graph for this function:

Here is the caller graph for this function:

void yangapi_clean_rcb ( yangapi_cb_t rcb)

Clean a YANGAPI/RESTCONF control block.

Parameters
rcbYuma REST-API control block to free

Here is the call graph for this function:

void yangapi_clean_target_keyvalQ ( yangapi_cb_t rcb)

Free all the snmp target keyval entries.

Parameters
rcbcontrol block to use

Here is the call graph for this function:

Here is the caller graph for this function:

uint8 yangapi_cvt_method_coap ( yangapi_method_t  method_enum)

Get the libcoap numeric value for the HTTP method enum.

Parameters
method_enummethod name enumeration
Returns
libcoap numeric value; 255 if error
void yangapi_free_accept ( yangapi_accept_t accept_entry)

Free a YANGAPI accept header entries.

Parameters
accept_entryYuma REST-API parameter to free

Here is the caller graph for this function:

void yangapi_free_param ( yangapi_param_t param)

Free a YANG-API parameter.

Parameters
paramYuma YANG-API parameter to free

Here is the caller graph for this function:

void yangapi_free_rcb ( yangapi_cb_t rcb)

Free a YANGAPI control block.

Parameters
rcbYuma YANG-API control block to free

Here is the call graph for this function:

Here is the caller graph for this function:

restconf_content_t yangapi_get_content_enum ( const xmlChar *  content)

Get the enum for the content query parameter from the query URI part.

Parameters
contentstring for the content query parameter
Returns
the restconf_content_t enumeration value for the string

Here is the call graph for this function:

Here is the caller graph for this function:

const xmlChar* yangapi_get_content_name ( restconf_content_t  content)

Get the keyword for the specified restconf_content_t enumeration.

Parameters
contentcontent query param name
Returns
string for the content query param type, or "none" or "illegal"
const xmlChar* yangapi_get_method_name ( yangapi_method_t  method_enum)

Get the method name from its enum.

Parameters
method_enummethod name enumeration
Returns
string for the enumeration
yangapi_accept_t* yangapi_new_accept ( const xmlChar *  mediatype,
uint32  media_type_len,
const xmlChar *  submediatype,
uint32  submediatype_len,
const xmlChar *  acc_format,
uint32  acc_format_len,
const xmlChar *  qvalue,
uint32  qvalue_len 
)

Create a new YANGAPI paramater.

Parameters
mediatypemedia type found
media_type_lenlength of mediatype parameter
submediatypesub-media type found
submediatype_lenlength of submediatype parameter
acc_formataccept format parameter
acc_format_lenlength of accept format parameter
qvalueQ value parametern
qvalue_lenlength of Q value parameter
Returns
pointer to initialized param, or NULL if malloc error

Here is the call graph for this function:

yangapi_param_t* yangapi_new_param ( const xmlChar *  parmname,
uint32  parmnamelen,
const xmlChar *  parmval,
uint32  parmvallen 
)

Create a new YANGAPI paramater.

Parameters
parmnameparameter name
parmnamelenparameter name string length
parmvalparameter value
parmvallenparameter value string length
Returns
pointer to initialized param, or NULL if malloc error

Here is the call graph for this function:

Here is the caller graph for this function:

yangapi_cb_t* yangapi_new_rcb ( void  )

Create a new YANG-API control block.

Returns
pointer to initialized RCB, or NULL if malloc error

Here is the call graph for this function:

Here is the caller graph for this function: