settings_store_itf Struct Reference

Backend handler functions. More...

#include <zephyr/settings/settings.h>

Data Fields
int(*	csi_load )(struct settings_store *cs, const struct settings_load_arg *arg)
	Loads values from storage limited to subtree defined by subtree.
ssize_t(*	csi_load_one )(struct settings_store *cs, const char *name, char *buf, size_t buf_len)
	Loads one value from storage that corresponds to the key defined by name.
ssize_t(*	csi_get_val_len )(struct settings_store *cs, const char *name)
	Gets the value's length associated to the Key defined by name.
int(*	csi_save_start )(struct settings_store *cs)
	Handler called before an export operation.
int(*	csi_save )(struct settings_store *cs, const char *name, const char *value, size_t val_len)
	Save a single key-value pair to storage.
int(*	csi_save_end )(struct settings_store *cs)
	Handler called after an export operation.
void *(*	csi_storage_get )(struct settings_store *cs)
	Get pointer to the storage instance used by the backend.

Detailed Description

Backend handler functions.

Sources are registered using a call to settings_src_register. Destinations are registered using a call to settings_dst_register.

Field Documentation

csi_get_val_len

ssize_t(* settings_store_itf::csi_get_val_len) (struct settings_store *cs, const char *name)

Gets the value's length associated to the Key defined by name.

It returns 0 if the Key/Value doesn't exist.

Parameters

[in]	cs	Corresponding backend handler node.
[in]	name	Key in string format.

Returns

0 if the Key/Value doesn't exist

csi_load

int(* settings_store_itf::csi_load) (struct settings_store *cs, const struct settings_load_arg *arg)

Loads values from storage limited to subtree defined by subtree.

Parameters

[in]	cs	Corresponding backend handler node,
[in]	arg	Structure that holds additional data for data loading.

Note

Backend is expected not to provide duplicates of the entities. It means that if the backend does not contain any functionality to really delete old keys, it has to filter out old entities and call load callback only on the final entity.

Returns

Actual size of value that corresponds to name on success, negative value on failure.

csi_load_one

ssize_t(* settings_store_itf::csi_load_one) (struct settings_store *cs, const char *name, char *buf, size_t buf_len)

Loads one value from storage that corresponds to the key defined by name.

Parameters

[in]	cs	Corresponding backend handler node.
[in]	name	Key in string format.
[in]	buf	Buffer where data should be copied.
[in]	buf_len	Length of buf.

Returns

Actual size of value that corresponds to name on success, negative value on failure

csi_save

int(* settings_store_itf::csi_save) (struct settings_store *cs, const char *name, const char *value, size_t val_len)

Save a single key-value pair to storage.

Parameters

[in]	cs	Corresponding backend handler node
[in]	name	Key in string format
[in]	value	Binary value
[in]	val_len	Length of value in bytes.

Returns

0 on success, negative error number on failure

csi_save_end

int(* settings_store_itf::csi_save_end) (struct settings_store *cs)

Handler called after an export operation.

Parameters

[in]

cs

Corresponding backend handler node

Returns

0 on success, negative error number on failure

csi_save_start

int(* settings_store_itf::csi_save_start) (struct settings_store *cs)

Handler called before an export operation.

Parameters

[in]

cs

Corresponding backend handler node

Returns

0 on success, negative error number on failure

csi_storage_get

void *(* settings_store_itf::csi_storage_get) (struct settings_store *cs)

Get pointer to the storage instance used by the backend.

Parameters

[in]

cs

Corresponding backend handler node

Returns

Pointer to storage object

---

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

• zephyr/settings/settings.h