Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Functions
UserAppConfigDb Configuration [OPENAPI_USERAPP_CONFIG_DB]

Functions

open_error_t openapiUserAppConfigDbCreateAppDb (openapiClientHandle_t *client_handle, open_buffdesc appDbName)
 Create DB for specified application. More...
 
open_error_t openapiUserAppConfigDbDeleteAppDb (openapiClientHandle_t *client_handle, open_buffdesc appDbName)
 Delete DB for specified application. More...
 
open_error_t openapiUserAppConfigDbGet (openapiClientHandle_t *client_handle, open_buffdesc appDbName, open_buffdesc keyName, open_buffdesc *keyData)
 Get userAppConfigDb entry. More...
 
open_error_t openapiUserAppConfigDbGetNext (openapiClientHandle_t *client_handle, open_buffdesc appDbName, open_buffdesc *keyName, open_buffdesc *keyData)
 Get next userAppConfigDb entry. More...
 
open_error_t openapiUserAppConfigDbRemoveItem (openapiClientHandle_t *client_handle, open_buffdesc appDbName, open_buffdesc keyName)
 Remove userAppConfigDb entry. More...
 
open_error_t openapiUserAppConfigDbSet (openapiClientHandle_t *client_handle, open_buffdesc appDbName, open_buffdesc keyName, open_buffdesc keyData)
 Add or update userAppConfigDb entry. More...
 

Detailed Description

Function Documentation

open_error_t openapiUserAppConfigDbCreateAppDb ( openapiClientHandle_t client_handle,
open_buffdesc  appDbName 
)

Create DB for specified application.

Parameters
[in]client_handleClient handle from registration API
[in]appDbNameApplication DB name
-Minimum length 1
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE
Return values
OPEN_E_NONESuccessful.
OPEN_E_EXISTSApp. DB is already created.
OPEN_E_PARAMError in parameter passed.
OPEN_E_FAILFailed.

OpEN API Version: 1.8

Examples:
userapp_config_db_example.c.
open_error_t openapiUserAppConfigDbDeleteAppDb ( openapiClientHandle_t client_handle,
open_buffdesc  appDbName 
)

Delete DB for specified application.

Parameters
[in]appDbNameApplication DB name
-Minimum length 1
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE
Return values
OPEN_E_NONESuccessful.
OPEN_E_NOT_FOUNDApp. DB was not found.
OPEN_E_PARAMError in parameter passed.
OPEN_E_FAILFailed.

OpEN API Version: 1.8

Examples:
userapp_config_db_example.c.
open_error_t openapiUserAppConfigDbGet ( openapiClientHandle_t client_handle,
open_buffdesc  appDbName,
open_buffdesc  keyName,
open_buffdesc keyData 
)

Get userAppConfigDb entry.

Parameters
[in]client_handleClient handle from registration API
[in]appDbNameApplication DB name
-Minimum length 1
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE
[in]keyNameBuffer descriptor key name
-Minimum length 1
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE
[in,out]keyDataPointer to key data. Memory must be allocated. If keyData->size is 0 or more than actual key data size then actual key data size will be returned.
-Minimum length 0
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE
Return values
OPEN_E_NONESuccessful.
OPEN_E_UNAVAILKey name was not found in app. DB.
OPEN_E_NOT_FOUNDInput app. DB was not found.
OPEN_E_PARAMError in parameter passed
OPEN_E_FAILFailed.

OpEN API Version: 1.6

Examples:
userapp_config_db_example.c.
open_error_t openapiUserAppConfigDbGetNext ( openapiClientHandle_t client_handle,
open_buffdesc  appDbName,
open_buffdesc keyName,
open_buffdesc keyData 
)

Get next userAppConfigDb entry.

Parameters
[in]appDbNameapplication DB name
[in]keyNamepointer to next key name. Memory must be allocated.
-Minimum length 1
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE If (keyName->pstart[0] == L7_EOS) - first key will be returned.
[out]keyDatapointer to next key data. Memory must be allocated.
-Minimum length 0
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE If L7_NULLPTR is specified then keySize will not be returned. If *keySize is 0 or more than actual key data size then actual key data size will be returned.
Return values
OPEN_E_PARAMin case of invalid input parameters
OPEN_E_NONEin case of successful operation
OPEN_E_NOT_FOUNDif input application DB wasn't found
OPEN_E_UNAVAILif item with specified keyName wasn't found
OPEN_E_FAILif operation failed

OpEN API Version: 1.11

Examples:
userapp_config_db_example.c.
open_error_t openapiUserAppConfigDbRemoveItem ( openapiClientHandle_t client_handle,
open_buffdesc  appDbName,
open_buffdesc  keyName 
)

Remove userAppConfigDb entry.

Parameters
[in]client_handleClient handle from registration API
[in]appDbNameApplication DB name
-Minimum length 1
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE
[in]keyNameBuffer descriptor key name
-Minimum length 1
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE
Return values
OPEN_E_NONEsuccessful.
OPEN_E_FAILfailed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILKey name was not found in app. DB.
OPEN_E_NOT_FOUNDInput app. DB was not found.

OpEN API Version: 1.6

Examples:
userapp_config_db_example.c.
open_error_t openapiUserAppConfigDbSet ( openapiClientHandle_t client_handle,
open_buffdesc  appDbName,
open_buffdesc  keyName,
open_buffdesc  keyData 
)

Add or update userAppConfigDb entry.

Parameters
[in]client_handleClient handle from registration API
[in]appDbNameApplication DB name
-Minimum length 1
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE
[in]keyNameBuffer descriptor key name
-Minimum length 1
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE
[in]keyDatapointer to buffer descriptor key data
-Minimum length 0
-Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE
Return values
OPEN_E_NONEGot successful.
OPEN_E_FAILGot failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_NOT_FOUNDInput app. DB was not found.

OpEN API Version: 1.6

Examples:
userapp_config_db_example.c.