yumapro  23.10T-5
YumaPro SDK
Loading...
Searching...
No Matches
DB-API Data Types

DB-API data types are used only by the db_api.c C code. More...

Collaboration diagram for DB-API Data Types:

Data Structures

struct  db_api_cb_t
 internal control block for the DB-API module More...
 

Typedefs

typedef void(* db_api_dataresp_cbfn_t) (status_t res, val_value_t *val, void *cookie)
 user function callback template for processing the val_value_t tree for the server data response. More...
 

Enumerations

enum  db_api_state_t {
  DB_API_ST_NONE ,
  DB_API_ST_START ,
  DB_API_ST_STOPPED ,
  DB_API_ST_ERROR ,
  DB_API_ST_WAIT_REGISTER ,
  DB_API_ST_READY ,
  DB_API_ST_WAIT_EDIT ,
  DB_API_ST_WAIT_GETCONFIG ,
  DB_API_ST_WAIT_DB_LOCK_INIT ,
  DB_API_ST_WAIT_SUBRPC
}
 DB-API service state machine enumerations. More...
 
enum  lock_state_t {
  LOCK_ST_NONE ,
  LOCK_ST_WAIT_INIT ,
  LOCK_ST_IDLE ,
  LOCK_ST_LOCAL_LOCKED ,
  LOCK_ST_SERVER_LOCKED ,
  LOCK_ST_ERROR
}
 db-lock state enumerations More...
 

Detailed Description

DB-API data types are used only by the db_api.c C code.

Do not use directly!

Typedef Documentation

◆ db_api_dataresp_cbfn_t

typedef void(* db_api_dataresp_cbfn_t) (status_t res, val_value_t *val, void *cookie)

user function callback template for processing the val_value_t tree for the server data response.

  • Used with the db_api_getfilter_cb API.
  • The callback is not expected to return a value.
  • It is called once at the conclusion of the get operation.
  • Type name: db_api_dataresp_cbfn_t
Parameters
resresult of the get request; if error then val will be NULL
valvalue node representing the 'config' root node received from the server for the corresponding get request
cookiecookie param passed to db_api_getfilter_cb

Enumeration Type Documentation

◆ db_api_state_t

DB-API service state machine enumerations.

Enumerator
DB_API_ST_NONE 

not set

DB_API_ST_START 

DB-API is starting up.

DB_API_ST_STOPPED 

DB-API is stopped.

DB_API_ST_ERROR 

DB-API in error state.

DB_API_ST_WAIT_REGISTER 

DB-API waiting for reply to register.

DB_API_ST_READY 

DB-API is ready for using request APIs.

DB_API_ST_WAIT_EDIT 

DB-API is waiting for a server response to an edit request.

DB_API_ST_WAIT_GETCONFIG 

DB-API is waiting for a server response to a get request.

DB_API_ST_WAIT_DB_LOCK_INIT 

DB-API is waiting for a server response to a db-lock init request.

DB_API_ST_WAIT_SUBRPC 

DB-API is waiting for a server response to a subrpc request.

◆ lock_state_t

db-lock state enumerations

Enumerator
LOCK_ST_NONE 

not set

LOCK_ST_WAIT_INIT 

waiting for server response to init request

LOCK_ST_IDLE 

ready for use

LOCK_ST_LOCAL_LOCKED 

currently locked by a local system user

LOCK_ST_SERVER_LOCKED 

currently locked by the main server

LOCK_ST_ERROR 

db-lock error state