KV.h File Reference

#include "Types.h"

Go to the source code of this file.

Typedefs
typedef address	DynXXKVConnHandle

Functions
DynXXKVConnHandle	dynxx_kv_open (const char *_id)
	open KV Store, support to access from multiple processes
const char *	dynxx_kv_read_string (DynXXKVConnHandle conn, const char *k)
	Read string from KV Store.
bool	dynxx_kv_write_string (DynXXKVConnHandle conn, const char *k, const char *v)
	Write string to KV Store.
int64_t	dynxx_kv_read_integer (DynXXKVConnHandle conn, const char *k)
	Read integer from KV Store.
bool	dynxx_kv_write_integer (DynXXKVConnHandle conn, const char *k, int64_t v)
	Write integer to KV Store.
double	dynxx_kv_read_float (DynXXKVConnHandle conn, const char *k)
	Read float from KV Store.
bool	dynxx_kv_write_float (DynXXKVConnHandle conn, const char *k, double v)
	Write float to KV Store.
const char **	dynxx_kv_all_keys (DynXXKVConnHandle conn, DYNXX_OUT size_t *outLen)
	Fetch all keys from KV Store.
bool	dynxx_kv_contains (DynXXKVConnHandle conn, const char *k)
	Search key from KV Store.
bool	dynxx_kv_remove (DynXXKVConnHandle conn, const char *k)
	Remove key-value from KV Store.
void	dynxx_kv_clear (DynXXKVConnHandle conn)
	Clear a KV Store.
void	dynxx_kv_close (DynXXKVConnHandle conn)
	Close a KV Store connection.

Typedef Documentation

DynXXKVConnHandle

typedef address DynXXKVConnHandle

Function Documentation

dynxx_kv_all_keys()

const char ** dynxx_kv_all_keys	(	DynXXKVConnHandle	conn,
		DYNXX_OUT size_t *	outLen
	)

Fetch all keys from KV Store.

Parameters

conn	A KV connection handle
outLen	A pointer to read the length of the key array

Returns

A pointer to the key array

dynxx_kv_clear()

void dynxx_kv_clear

(

DynXXKVConnHandle

conn

)

Clear a KV Store.

Parameters

conn	A KV connection handle

dynxx_kv_close()

void dynxx_kv_close

(

DynXXKVConnHandle

conn

)

Close a KV Store connection.

Parameters

conn	A KV connection handle

dynxx_kv_contains()

bool dynxx_kv_contains	(	DynXXKVConnHandle	conn,
		const char *	k
	)

Search key from KV Store.

Parameters

conn	A KV connection handle
k	key

Returns

Exist or not

dynxx_kv_open()

DynXXKVConnHandle dynxx_kv_open

(

const char *

_id

)

open KV Store, support to access from multiple processes

Parameters

_id

kv id

Returns

A KV connection handle

dynxx_kv_read_float()

double dynxx_kv_read_float	(	DynXXKVConnHandle	conn,
		const char *	k
	)

Read float from KV Store.

Parameters

conn	A KV connection handle
k	key

Returns

float value

dynxx_kv_read_integer()

int64_t dynxx_kv_read_integer	(	DynXXKVConnHandle	conn,
		const char *	k
	)

Read integer from KV Store.

Parameters

conn	A KV connection handle
k	key

Returns

integer value

dynxx_kv_read_string()

const char * dynxx_kv_read_string	(	DynXXKVConnHandle	conn,
		const char *	k
	)

Read string from KV Store.

Parameters

conn	A KV connection handle
k	key

Returns

String value

dynxx_kv_remove()

bool dynxx_kv_remove	(	DynXXKVConnHandle	conn,
		const char *	k
	)

Remove key-value from KV Store.

Parameters

conn	A KV connection handle
k	key

Returns

Success or not

dynxx_kv_write_float()

bool dynxx_kv_write_float	(	DynXXKVConnHandle	conn,
		const char *	k,
		double	v
	)

Write float to KV Store.

Parameters

conn	A KV connection handle
k	key
v	value

Returns

Successfull or not

dynxx_kv_write_integer()

bool dynxx_kv_write_integer	(	DynXXKVConnHandle	conn,
		const char *	k,
		int64_t	v
	)

Write integer to KV Store.

Parameters

conn	A KV connection handle
k	key
v	value

Returns

Successfull or not

dynxx_kv_write_string()

bool dynxx_kv_write_string	(	DynXXKVConnHandle	conn,
		const char *	k,
		const char *	v
	)

Write string to KV Store.

Parameters

conn	A KV connection handle
k	key
v	value

Returns

Successfull or not