Symbols

loading...

Files

loading (2/5)...

Summary Syntax Values References Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFnvs::VerOffset

nvs::VerOffset enum

Used to recognize transient states of a blob. Once a blob is modified, new chunks with the new data are written with a new version. The version is saved in the highest bit of Item::chunkIndex as well as in Item::blobIndex::chunkStart. If a chunk is modified and hence re-written, the version swaps: 0x0 -> 0x80 or 0x80 -> 0x0.

Syntax

Show:

Summary

Declaration

from nvs_types.hpp:29

enum class VerOffset: uint8_t { VER_0_OFFSET = 0x0, VER_1_OFFSET = 0x80, VER_ANY = 0xff, };

Values

Value

Declared as

nvs::VerOffset::VER_0_OFFSET

= 0x0

nvs::VerOffset::VER_1_OFFSET

= 0x80

nvs::VerOffset::VER_ANY

= 0xff

References

Code

Location

Scope

Referrer

enum class VerOffset: uint8_t {

nvs_types.hpp:29

esp_err_t Page::readItem(uint8_t nsIndex, ItemType datatype, const char* key, void* data, size_t dataSize, uint8_t chunkIdx, VerOffset chunkStart)

nvs_page.cpp:253

nvs::Page::readItem()

esp_err_t Page::cmpItem(uint8_t nsIndex, ItemType datatype, const char* key, const void* data, size_t dataSize, uint8_t chunkIdx, VerOffset chunkStart)

nvs_page.cpp:304

nvs::Page::cmpItem()

nvs::Page::cmpItem()::chunkStart

esp_err_t Page::eraseItem(uint8_t nsIndex, ItemType datatype, const char* key, uint8_t chunkIdx, VerOffset chunkStart)

nvs_page.cpp:356

nvs::Page::eraseItem()

esp_err_t Page::findItem(uint8_t nsIndex, ItemType datatype, const char* key, uint8_t chunkIdx, VerOffset chunkStart)

nvs_page.cpp:367

nvs::Page::findItem()

nvs::Page::findItem()::chunkStart

esp_err_t Page::findItem(uint8_t nsIndex, ItemType datatype, const char* key, size_t &itemIndex, Item &item, uint8_t chunkIdx, VerOffset chunkStart)

nvs_page.cpp:865

nvs::Page::findItem()

nvs::Page::findItem()::chunkStart

&& chunkStart != VerOffset::VER_ANY

nvs_page.cpp:976

nvs::Page::findItem()

esp_err_t readItem(uint8_t nsIndex, ItemType datatype, const char* key, void* data, size_t dataSize, uint8_t chunkIdx = CHUNK_ANY, VerOffset chunkStart = VerOffset::VER_ANY);

nvs_page.hpp:91

nvs::Page::readItem()

esp_err_t cmpItem(uint8_t nsIndex, ItemType datatype, const char* key, const void* data, size_t dataSize, uint8_t chunkIdx = CHUNK_ANY, VerOffset chunkStart = VerOffset::VER_ANY);

nvs_page.hpp:93

nvs::Page::cmpItem()

nvs::Page::cmpItem()::chunkStart

esp_err_t eraseItem(uint8_t nsIndex, ItemType datatype, const char* key, uint8_t chunkIdx = CHUNK_ANY, VerOffset chunkStart = VerOffset::VER_ANY);

nvs_page.hpp:95

nvs::Page::eraseItem()

esp_err_t findItem(uint8_t nsIndex, ItemType datatype, const char* key, uint8_t chunkIdx = CHUNK_ANY, VerOffset chunkStart = VerOffset::VER_ANY);

nvs_page.hpp:97

nvs::Page::findItem()

nvs::Page::findItem()::chunkStart

esp_err_t findItem(uint8_t nsIndex, ItemType datatype, const char* key, size_t &itemIndex, Item& item, uint8_t chunkIdx = CHUNK_ANY, VerOffset chunkStart = VerOffset::VER_ANY);

nvs_page.hpp:99

nvs::Page::findItem()

nvs::Page::findItem()::chunkStart

esp_err_t Storage::findItem(uint8_t nsIndex, ItemType datatype, const char* key, Page* &page, Item& item, uint8_t chunkIdx, VerOffset chunkStart)

nvs_storage.cpp:257

nvs::Storage::findItem()

nvs::Storage::findItem()::chunkStart

esp_err_t Storage::writeMultiPageBlob(uint8_t nsIndex, const char* key, const void* data, size_t dataSize, VerOffset chunkStart)

nvs_storage.cpp:270

nvs::Storage::writeMultiPageBlob()

nvs::Storage::writeMultiPageBlob()::chunkStart

VerOffset prevStart, nextStart;

nvs_storage.cpp:410

nvs::Storage::writeItem()

prevStart = nextStart = VerOffset::VER_0_OFFSET;

nvs_storage.cpp:411

nvs::Storage::writeItem()

NVS_ASSERT_OR_RETURN(prevStart == VerOffset::VER_0_OFFSET || prevStart == VerOffset::VER_1_OFFSET, ESP_FAIL);

nvs_storage.cpp:429

nvs::Storage::writeItem()

= (prevStart == VerOffset::VER_1_OFFSET) ? VerOffset::VER_0_OFFSET : VerOffset::VER_1_OFFSET;

nvs_storage.cpp:434

nvs::Storage::writeItem()

VerOffset chunkStart = item.blobIndex.chunkStart;

nvs_storage.cpp:595

nvs::Storage::readMultiPageBlob()

VerOffset chunkStart = item.blobIndex.chunkStart;

nvs_storage.cpp:645

nvs::Storage::cmpMultiPageBlob()

esp_err_t Storage::eraseMultiPageBlob(uint8_t nsIndex, const char* key, VerOffset chunkStart)

nvs_storage.cpp:698

nvs::Storage::eraseMultiPageBlob()

nvs::Storage::eraseMultiPageBlob()::chunkStart

if(chunkStart == VerOffset::VER_ANY)

nvs_storage.cpp:719

nvs::Storage::eraseMultiPageBlob()

uint8_t minChunkIndex = (uint8_t) VerOffset::VER_0_OFFSET;

nvs_storage.cpp:733

nvs::Storage::eraseMultiPageBlob()

uint8_t maxChunkIndex = (uint8_t) VerOffset::VER_ANY;

nvs_storage.cpp:734

nvs::Storage::eraseMultiPageBlob()

if(chunkStart == VerOffset::VER_0_OFFSET) {

nvs_storage.cpp:736

nvs::Storage::eraseMultiPageBlob()

maxChunkIndex = (uint8_t) VerOffset::VER_1_OFFSET;

nvs_storage.cpp:737

nvs::Storage::eraseMultiPageBlob()

} else if (chunkStart == VerOffset::VER_1_OFFSET) {

nvs_storage.cpp:738

nvs::Storage::eraseMultiPageBlob()

minChunkIndex = (uint8_t) VerOffset::VER_1_OFFSET;

nvs_storage.cpp:739

nvs::Storage::eraseMultiPageBlob()

!(item.chunkIndex == static_cast<uint8_t>(VerOffset::VER_0_OFFSET)

nvs_storage.cpp:971

nvs::isMultipageBlob()

|| item.chunkIndex == static_cast<uint8_t>(VerOffset::VER_1_OFFSET)));

nvs_storage.cpp:972

nvs::isMultipageBlob()

VerOffset chunkStart;

nvs_storage.hpp:50

nvs::Storage::BlobIndexNode

nvs::Storage::BlobIndexNode::chunkStart

esp_err_t writeMultiPageBlob(uint8_t nsIndex, const char* key, const void* data, size_t dataSize, VerOffset chunkStart);

nvs_storage.hpp:117

nvs::Storage::writeMultiPageBlob()

nvs::Storage::writeMultiPageBlob()::chunkStart

esp_err_t eraseMultiPageBlob(uint8_t nsIndex, const char* key, VerOffset chunkStart = VerOffset::VER_ANY);

nvs_storage.hpp:123

nvs::Storage::eraseMultiPageBlob()

nvs::Storage::eraseMultiPageBlob()::chunkStart

esp_err_t findItem(uint8_t nsIndex, ItemType datatype, const char* key, Page* &page, Item& item, uint8_t chunkIdx = Page::CHUNK_ANY, VerOffset chunkStart = VerOffset::VER_ANY);

nvs_storage.hpp:156

nvs::Storage::findItem()

nvs::Storage::findItem()::chunkStart

VerOffset chunkStart; // Offset from which the chunkIndex for children blobs starts

nvs_types.hpp:62

nvs::Item::::::::::chunkStart

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

All items filtered out

All items filtered out

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Instance

Scope

Location

Project

nvs::Item::::::::::chunkStart

nvs_types.hpp:62

nvs::Page::cmpItem()::chunkStart

nvs::Page::cmpItem()

nvs_page.hpp:93

nvs::Page::findItem()::chunkStart

nvs::Page::findItem()

nvs_page.hpp:97

nvs::Page::findItem()::chunkStart

nvs::Page::findItem()

nvs_page.hpp:99

nvs::Storage::BlobIndexNode::chunkStart

nvs::Storage::BlobIndexNode

nvs_storage.hpp:50

nvs::Storage::writeMultiPageBlob()::chunkStart

nvs::Storage::writeMultiPageBlob()

nvs_storage.hpp:117

nvs::Storage::eraseMultiPageBlob()::chunkStart

nvs::Storage::eraseMultiPageBlob()

nvs_storage.hpp:123

nvs::Storage::findItem()::chunkStart

nvs::Storage::findItem()

nvs_storage.hpp:156

nvs::Page::cmpItem()::chunkStart

nvs::Page::cmpItem()

nvs_page.cpp:304

nvs::Page::findItem()::chunkStart

nvs::Page::findItem()

nvs_page.cpp:367

nvs::Page::findItem()::chunkStart

nvs::Page::findItem()

nvs_page.cpp:865

nvs::Storage::findItem()::chunkStart

nvs::Storage::findItem()

nvs_storage.cpp:257

nvs::Storage::writeMultiPageBlob()::chunkStart

nvs::Storage::writeMultiPageBlob()

nvs_storage.cpp:270

nvs::Storage::eraseMultiPageBlob()::chunkStart

nvs::Storage::eraseMultiPageBlob()

nvs_storage.cpp:698

Lifecycle

All items filtered out

All items filtered out