ndnph::KvStore Class Reference

File based key-value store. More...

#include <kv.hpp>

Inherited by ndnph::PacketStore< Data >, ndnph::KeyChainKeys, and ndnph::PacketStore< T >.

Public Member Functions
	KvStore ()=default
	Constructor to use internal FileStore instance. More...
	KvStore (port::FileStore &fs)
	Constructor to use existing FileStore instance. More...
template<typename... Arg>
bool	open (Arg &&... arg)
	Open the FileStore backend. More...
tlv::Value	get (const char *key, Region &region)
	Retrieve a value. More...
bool	set (const char *key, tlv::Value value)
	Store a value. More...
bool	del (const char *key)
	Delete a key. More...

Detailed Description

File based key-value store.

Constructor & Destructor Documentation

KvStore() [1/2]

ndnph::KvStore::KvStore ( )

explicitdefault

Constructor to use internal FileStore instance.

KvStore() [2/2]

ndnph::KvStore::KvStore ( port::FileStore &  fs )

inlineexplicit

Constructor to use existing FileStore instance.

Member Function Documentation

del()

bool ndnph::KvStore::del ( const char *  key )

inline

Delete a key.

Parameters

key	non-empty key, can only contain digits, lower-case letters, and '_'.

Returns

whether success; deleting a non-existent key is considered successful.

get()

tlv::Value ndnph::KvStore::get ( const char *  key, Region &  region  )

inline

Retrieve a value.

Parameters

key	non-empty key, can only contain digits, lower-case letters, and '_'.
region	where to allocate memory.

Returns

the value. Empty value upon error.

open()

template<typename... Arg>

bool ndnph::KvStore::open ( Arg &&...  arg )

inline

Open the FileStore backend.

Template Parameters

Arg	arguments passed to port::FileStore::open() function.

set()

bool ndnph::KvStore::set ( const char *  key, tlv::Value  value  )

inline

Store a value.

Parameters

key	non-empty key, can only contain digits, lower-case letters, and '_'.
value	the value.

Returns

whether success.

When multiple KvStores are created over the same FileStore backend (same instance, or different instances but using the directory), it is the caller's responsibility to ensure that keys do not conflict among different KvStores.

---

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

• /home/runner/work/esp8266ndn/NDNph/src/ndnph/store/kv.hpp