Settings backend interface

settings More...

Data Structures
struct	settings_store
	Backend handler node for storage handling. More...
struct	settings_load_arg
	Arguments for data loading. More...
struct	settings_store_itf
	Backend handler functions. More...

Functions
void	settings_src_register (struct settings_store *cs)
	Register a backend handler acting as source.
void	settings_dst_register (struct settings_store *cs)
	Register a backend handler acting as destination.
struct settings_handler_static *	settings_parse_and_lookup (const char *name, const char **next)
	Parses a key to an array of elements and locate corresponding module handler.
int	settings_call_set_handler (const char *name, size_t len, settings_read_cb read_cb, void *read_cb_arg, const struct settings_load_arg *load_arg)
	Calls settings handler.

Detailed Description

settings

Function Documentation

settings_call_set_handler()

int settings_call_set_handler	(	const char *	name,
		size_t	len,
		settings_read_cb	read_cb,
		void *	read_cb_arg,
		const struct settings_load_arg *	load_arg
	)

#include <zephyr/settings/settings.h>

Calls settings handler.

Parameters

[in]	name	The name of the data found in the backend.
[in]	len	The size of the data found in the backend.
[in]	read_cb	Function provided to read the data from the backend.
[in,out]	read_cb_arg	Arguments for the read function provided by the backend.
[in,out]	load_arg	Arguments for data loading.

Returns

0 or negative error code

settings_dst_register()

void settings_dst_register

(

struct settings_store *

cs

)

#include <zephyr/settings/settings.h>

Register a backend handler acting as destination.

Parameters

cs	Backend handler node containing handler information.

settings_parse_and_lookup()

struct settings_handler_static * settings_parse_and_lookup	(	const char *	name,
		const char **	next
	)

#include <zephyr/settings/settings.h>

Parses a key to an array of elements and locate corresponding module handler.

Parameters

[in]	name	in string format
[out]	next	remaining of name after matched handler

Returns

settings_handler_static on success, NULL on failure.

settings_src_register()

void settings_src_register

(

struct settings_store *

cs

)

#include <zephyr/settings/settings.h>

Register a backend handler acting as source.

Parameters

cs	Backend handler node containing handler information.