mirror of
https://gitee.com/beecue/fastbee.git
synced 2025-12-20 18:05:54 +08:00
73 lines
2.3 KiB
C
73 lines
2.3 KiB
C
/*
|
|
* Copyright (c) 2022 OpenLuat & AirM2M
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
* this software and associated documentation files (the "Software"), to deal in
|
|
* the Software without restriction, including without limitation the rights to
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
* the Software, and to permit persons to whom the Software is furnished to do so,
|
|
* subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef LUAT_KV_H
|
|
#define LUAT_KV_H
|
|
|
|
/**
|
|
* @defgroup luatos_kv 持久化数据存储接口
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief 初始化kv数据存储
|
|
*
|
|
* @return int == 0 正常 != 0失败
|
|
*/
|
|
int luat_kv_init(void);
|
|
|
|
/**
|
|
* @brief 删除指定的key
|
|
* @param key[IN] 待删除的key值
|
|
* @return int == 0 正常 != 0失败
|
|
*/
|
|
int luat_kv_del(const char* key);
|
|
|
|
/**
|
|
* @brief 写入指定key的数据
|
|
* @param key[IN] 待写入的key值,不能为NULL,必须是\0结尾,最大长度64字节
|
|
* @param data[IN] 待写入的数据, 不需要\0结尾
|
|
* @param len[IN] 待写入的数据长度, 不含\0,当前支持最大长度255字节
|
|
* @return int == 0 正常 != 0失败
|
|
*/
|
|
int luat_kv_set(const char* key, void* data, size_t len);
|
|
|
|
/**
|
|
* @brief 读取指定key的数据
|
|
* @param key[IN] 待读取的key值,不能为NULL,必须是\0结尾
|
|
* @param data[IN] 待读取的数据, 可写入空间必须大于等于len值
|
|
* @param len[IN] 待读取的数据长度最大长度, 不含\0
|
|
* @return int > 0 实际读取的长度, <=0 失败
|
|
*/
|
|
int luat_kv_get(const char* key, void* data, size_t len);
|
|
|
|
/**
|
|
* @brief 清空所有数据
|
|
* @return int == 0 正常 != 0失败
|
|
*/
|
|
int luat_kv_clear(void);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif
|