Symbols ![]()
loading...
Files ![]()
loading...
nvs::NVSHandleSimple class
This class implements NVSHandle according to the ESP32's flash and partitioning scheme. It is used by both the C API and the C++ API. The main responsibility is to check whether the handle is valid and in the right read/write mode and then forward the calls to the storage object. For more details about the general member functions, see nvs_handle.hpp.
Syntax
class NVSHandleSimple : public intrusive_list_node<NVSHandleSimple>,
public NVSHandle,
public ExceptionlessAllocatable
{
friend class NVSPartitionManager;
public:
NVSHandleSimple(bool readOnly, uint8_t nsIndex, Storage *StoragePtr) :
mStoragePtr(StoragePtr),
mNsIndex(nsIndex),
mReadOnly(readOnly),
valid(1)
{ }
~NVSHandleSimple();
esp_err_t set_typed_item(ItemType datatype, const char *key, const void *data, size_t dataSize) override;
esp_err_t get_typed_item(ItemType datatype, const char *key, void *data, size_t dataSize) override;
esp_err_t set_string(const char *key, const char *str) override;
esp_err_t set_blob(const char *key, const void *blob, size_t len) override;
esp_err_t get_string(const char *key, char *out_str, size_t len) override;
esp_err_t get_blob(const char *key, void *out_blob, size_t len) override;
esp_err_t get_item_size(ItemType datatype, const char *key, size_t &size) override;
esp_err_t find_key(const char *key, nvs_type_t &nvstype) override;
esp_err_t erase_item(const char *key) override;
esp_err_t erase_all() override;
esp_err_t commit() override;
esp_err_t get_used_entry_count(size_t &usedEntries) override;
esp_err_t getItemDataSize(ItemType datatype, const char *key, size_t &dataSize);
void debugDump();
esp_err_t fillStats(nvs_stats_t &nvsStats);
esp_err_t calcEntriesInNamespace(size_t &usedEntries);
bool findEntry(nvs_opaque_iterator_t *it, const char *name);
bool findEntryNs(nvs_opaque_iterator_t *it);
bool nextEntry(nvs_opaque_iterator_t *it);
const char *get_partition_name() const;
Storage *get_storage() const;
private:
Storage *mStoragePtr;
uint8_t mNsIndex;
uint8_t mReadOnly;
uint8_t valid;
};
Fields
Field
Declared as
Description
uint8_t
Numeric representation of the namespace as it is saved in flash (see README.rst for further details).
uint8_t
Whether this handle is marked as read-only or read-write. 0 indicates read-only, any other value read-write.
uint8_t
Indicates the validity of this handle. Upon opening, a handle is valid. It becomes invalid if the underlying storage is de-initialized.
Related Functions
Found 5 other functions taking a NVSHandleSimple
argument: