LibXR::ESP32NvsFlashDatabase Class Reference

ESP32 NVS 数据库存储实现 / ESP32 NVS-backed database implementation. More...

#include <esp32_nvs_flash_database.hpp>

Inheritance diagram for LibXR::ESP32NvsFlashDatabase:

Collaboration diagram for LibXR::ESP32NvsFlashDatabase:

Public Member Functions
	ESP32NvsFlashDatabase (const char *namespace_name="storage")
	构造并初始化 NVS / Construct and initialize NVS storage
bool	IsValid () const
	查询初始化状态 / Check initialization state

Private Member Functions
ErrorCode	Add (KeyBase &key) override
	添加新键到数据库 (Add a new key to the database).
ErrorCode	Get (KeyBase &key) override
	从数据库获取键的值 (Retrieve the key's value from the database).
ErrorCode	Set (KeyBase &key, RawData data) override
	设置数据库中的键值 (Set the key's value in the database).

Private Attributes
const char *	namespace_
bool	valid_ {false}

Detailed Description

ESP32 NVS 数据库存储实现 / ESP32 NVS-backed database implementation.

Definition at line 19 of file esp32_nvs_flash_database.hpp.

Constructor & Destructor Documentation

ESP32NvsFlashDatabase()

LibXR::ESP32NvsFlashDatabase::ESP32NvsFlashDatabase ( const char * namespace_name = "storage" )

inlineexplicit

构造并初始化 NVS / Construct and initialize NVS storage

Parameters

namespace_name

命名空间名称 / Namespace name (default: "storage")

Definition at line 26 of file esp32_nvs_flash_database.hpp.

      : namespace_(namespace_name)
  {
    esp_err_t err = nvs_flash_init();
    if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND)
    {
      nvs_flash_erase();
      err = nvs_flash_init();
    }
    valid_ = (err == ESP_OK);
  }

Member Function Documentation

Add()

ErrorCode LibXR::ESP32NvsFlashDatabase::Add ( KeyBase & key )

inlineoverrideprivatevirtual

添加新键到数据库 (Add a new key to the database).

Parameters

key	需要添加的键 (Key to add).

Returns

操作结果 (Operation result).

Implements LibXR::Database.

Definition at line 47 of file esp32_nvs_flash_database.hpp.

{ return Set(key, key.raw_data_); }

Get()

ErrorCode LibXR::ESP32NvsFlashDatabase::Get ( KeyBase & key )

inlineoverrideprivatevirtual

从数据库获取键的值 (Retrieve the key's value from the database).

Parameters

key	需要获取的键 (Key to retrieve).

Returns

操作结果 (Operation result).

Implements LibXR::Database.

Definition at line 49 of file esp32_nvs_flash_database.hpp.

  {
    if (!valid_) return ErrorCode::FAILED;
 
    nvs_handle_t handle;
    esp_err_t err = nvs_open(namespace_, NVS_READONLY, &handle);
    if (err != ESP_OK) return ErrorCode::FAILED;
 
    size_t required_size = 0;
    err = nvs_get_blob(handle, key.name_, nullptr, &required_size);
    if (err == ESP_ERR_NVS_NOT_FOUND)
    {
      nvs_close(handle);
      return ErrorCode::NOT_FOUND;
    }
 
    if (required_size != key.raw_data_.size_)
    {
      nvs_close(handle);
      return ErrorCode::FAILED;
    }
 
    err = nvs_get_blob(handle, key.name_, key.raw_data_.addr_, &required_size);
    nvs_close(handle);
    return (err == ESP_OK) ? ErrorCode::OK : ErrorCode::FAILED;
  }

IsValid()

bool LibXR::ESP32NvsFlashDatabase::IsValid ( ) const

inline

查询初始化状态 / Check initialization state

Definition at line 41 of file esp32_nvs_flash_database.hpp.

{ return valid_; }

Set()

ErrorCode LibXR::ESP32NvsFlashDatabase::Set ( KeyBase & key, RawData data )

inlineoverrideprivatevirtual

设置数据库中的键值 (Set the key's value in the database).

Parameters

key	目标键 (Target key).
data	需要存储的新值 (New value to store).

Returns

操作结果 (Operation result).

Implements LibXR::Database.

Definition at line 76 of file esp32_nvs_flash_database.hpp.

  {
    if (!valid_) return ErrorCode::FAILED;
 
    nvs_handle_t handle;
    esp_err_t err = nvs_open(namespace_, NVS_READWRITE, &handle);
    if (err != ESP_OK) return ErrorCode::FAILED;
 
    err = nvs_set_blob(handle, key.name_, data.addr_, data.size_);
    if (err != ESP_OK)
    {
      nvs_close(handle);
      return ErrorCode::FAILED;
    }
 
    err = nvs_commit(handle);
    nvs_close(handle);
    return (err == ESP_OK) ? ErrorCode::OK : ErrorCode::FAILED;
  }

Field Documentation

namespace_

const char* LibXR::ESP32NvsFlashDatabase::namespace_

private

Definition at line 44 of file esp32_nvs_flash_database.hpp.

valid_

bool LibXR::ESP32NvsFlashDatabase::valid_ {false}

private

Definition at line 45 of file esp32_nvs_flash_database.hpp.

{false};

---

The documentation for this class was generated from the following file:

• driver/esp/esp32_nvs_flash_database.hpp