TuyaOS
tuya_ws_db.h
浏览该文件的文档.
1
13#ifndef _TUYA_WS_DB_H
14#define _TUYA_WS_DB_H
15
16#include "tuya_cloud_types.h"
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
26typedef BYTE_T VAR_TP_T;
27#define VT_CHAR 0 // char, same as int, need 11+6 byte
28#define VT_BYTE 1 // byte, same as int, need 11+6 byte
29#define VT_SHORT 2 // short, same as int, need 11+6 byte
30#define VT_USHORT 3 // unsigned short, same as int, need 11+6 byte
31#define VT_INT 4 // int, need 11+6 byte when serialize to json format
32#define VT_BOOL 5 // bool, need 6+6 byte when serialize to json format
33#define VT_STRING 6 // string, need len+6 byte when serialize to json format
34#define VT_RAW 7 // raw, need len/3*4+len%3?4:0+6 (base64 encode) when serialize to json format
35
40typedef struct {
41 CHAR_T *key; // property name
42 VAR_TP_T vt; // property type
43 VOID *val; // property value
44 USHORT_T len; // property length
46
47
58OPERATE_RET ws_db_init(IN CONST CHAR_T *fs_storge_path, IN CONST BYTE_T *p_key);
59
68OPERATE_RET ws_db_init_mf(VOID);
69
75VOID ws_db_uninit(VOID) ;
76
82OPERATE_RET ws_db_format(VOID);
83
89OPERATE_RET ws_db_rebuild(VOID);
90
99
108OPERATE_RET wd_common_write(IN CONST CHAR_T *key, IN CONST BYTE_T *value, IN CONST UINT_T len);
109
120OPERATE_RET wd_common_read(IN CONST CHAR_T *key, OUT BYTE_T **value, OUT UINT_T *p_len);
121
136OPERATE_RET wd_common_fuzzy_read(IN CONST CHAR_T *fuzzy_name, INOUT UINT_T *index, OUT BYTE_T **data, OUT UINT_T *len);
137
144OPERATE_RET wd_common_free_data(IN BYTE_T *data);
145
152OPERATE_RET wd_common_delete(IN CONST CHAR_T *key);
153
162OPERATE_RET wd_common_fuzzy_delete(IN CONST CHAR_T *key);
163
172OPERATE_RET wd_common_exist(IN CONST CHAR_T *key, OUT BOOL_T *exist);
173
182OPERATE_RET wd_protected_write(IN CONST CHAR_T *key, IN CONST BYTE_T *value, IN CONST UINT_T len);
183
194OPERATE_RET wd_protected_read(IN CONST CHAR_T *key, OUT BYTE_T **value, OUT UINT_T *p_len);
195
202OPERATE_RET wd_protected_delete(IN CONST CHAR_T *key);
203
213OPERATE_RET wd_user_param_write(IN CONST BYTE_T *data, IN CONST UINT_T len);
214
225OPERATE_RET wd_user_param_read(OUT BYTE_T **buf, OUT UINT_T *len);
226
236OPERATE_RET wd_utils_serialize(IN CONST TY_DB_RW_S *rw, IN CONST UINT_T rw_cnt, OUT CHAR_T **out, OUT UINT_T *out_len);
237
246OPERATE_RET wd_utils_serialize_save(IN CONST CHAR_T *key, IN CONST TY_DB_RW_S *rw, IN CONST UINT_T rw_cnt);
247
259OPERATE_RET wd_utils_serialize_restore(IN CONST CHAR_T *key, INOUT TY_DB_RW_S *rw, IN CONST UINT_T rw_cnt);
260
271OPERATE_RET wd_utils_deserialize(IN CONST CHAR_T *in, INOUT TY_DB_RW_S *rw, IN CONST UINT_T rw_cnt);
272
279OPERATE_RET wd_utils_free_outbuf(IN CHAR_T *out_buf);
280
281
282
283#ifdef __cplusplus
284}
285#endif
286#endif
287
tuya key-value database property, used for serialize/deserialize data to json format
Definition: tuya_ws_db.h:40
OPERATE_RET wd_common_fuzzy_delete(IN CONST CHAR_T *key)
fuzzy delete the entry from key-value database
OPERATE_RET wd_user_param_read(OUT BYTE_T **buf, OUT UINT_T *len)
read the user parameter from tuya key-value database
OPERATE_RET wd_common_delete(IN CONST CHAR_T *key)
delete the entry from key-value database
VOID ws_db_uninit(VOID)
tuya key-value database de-initialization
OPERATE_RET wd_protected_delete(IN CONST CHAR_T *key)
delete the entry from protected storage
OPERATE_RET wd_utils_deserialize(IN CONST CHAR_T *in, INOUT TY_DB_RW_S *rw, IN CONST UINT_T rw_cnt)
tuya key-value deserialize, transfer the data from json format to property array
OPERATE_RET wd_utils_free_outbuf(IN CHAR_T *out_buf)
free the buffer which allocated by wd_utils_serialize_restore
CHAR_T * ws_db_get_storage_path(VOID)
tuya key-value database get storage path
OPERATE_RET ws_db_init(IN CONST CHAR_T *fs_storge_path, IN CONST BYTE_T *p_key)
tuya key-value database initialization
OPERATE_RET wd_user_param_write(IN CONST BYTE_T *data, IN CONST UINT_T len)
write the user parameter to tuya key-value database
OPERATE_RET ws_db_rebuild(VOID)
tuya key-value database rebuild to recycle
OPERATE_RET wd_common_read(IN CONST CHAR_T *key, OUT BYTE_T **value, OUT UINT_T *p_len)
tuya key-value database read entry
OPERATE_RET ws_db_format(VOID)
tuya key-value database format
OPERATE_RET wd_protected_read(IN CONST CHAR_T *key, OUT BYTE_T **value, OUT UINT_T *p_len)
tuya protected storage read entry
OPERATE_RET wd_common_write(IN CONST CHAR_T *key, IN CONST BYTE_T *value, IN CONST UINT_T len)
tuya key-value database write entry
BYTE_T VAR_TP_T
tuya key-value database property define, used for serialize/deserialize data to json format
Definition: tuya_ws_db.h:26
OPERATE_RET wd_utils_serialize(IN CONST TY_DB_RW_S *rw, IN CONST UINT_T rw_cnt, OUT CHAR_T **out, OUT UINT_T *out_len)
tuya key-value serialize, transfer the data from TY_DB_RW_S array to json format
OPERATE_RET wd_utils_serialize_save(IN CONST CHAR_T *key, IN CONST TY_DB_RW_S *rw, IN CONST UINT_T rw_cnt)
tuya key-value serialize and save in tuya key-value database
OPERATE_RET wd_protected_write(IN CONST CHAR_T *key, IN CONST BYTE_T *value, IN CONST UINT_T len)
tuya protected storage write entry
OPERATE_RET ws_db_init_mf(VOID)
tuya key-value database initialization in mf
OPERATE_RET wd_common_fuzzy_read(IN CONST CHAR_T *fuzzy_name, INOUT UINT_T *index, OUT BYTE_T **data, OUT UINT_T *len)
tuya key-value database fuzzy read entry
OPERATE_RET wd_common_free_data(IN BYTE_T *data)
free the buffer which allocated by wd_common_read or wd_common_fuzzy_read
OPERATE_RET wd_common_exist(IN CONST CHAR_T *key, OUT BOOL_T *exist)
check the entry from key-value database
OPERATE_RET wd_utils_serialize_restore(IN CONST CHAR_T *key, INOUT TY_DB_RW_S *rw, IN CONST UINT_T rw_cnt)
tuya key-value serialize restore, will read the data from tuya key-value database and restore to data...