Zephyr API Documentation  2.7.0-rc2
A Scalable Open Source RTOS
Settings backend interface

Data Structures

struct  settings_store
 
struct  settings_load_arg
 
struct  settings_store_itf
 

Functions

void settings_src_register (struct settings_store *cs)
 
void settings_dst_register (struct settings_store *cs)
 
struct settings_handler_staticsettings_parse_and_lookup (const char *name, const char **next)
 
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)
 

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 <include/settings/settings.h>

Calls settings handler.

Parameters
[in]nameThe name of the data found in the backend.
[in]lenThe size of the data found in the backend.
[in]read_cbFunction provided to read the data from the backend.
[in,out]read_cb_argArguments for the read function provided by the backend.
[in,out]load_argArguments for data loading.
Returns
0 or negative error code

◆ settings_dst_register()

void settings_dst_register ( struct settings_store cs)

#include <include/settings/settings.h>

Register a backend handler acting as destination.

Parameters
csBackend handler node containing handler information.

◆ settings_parse_and_lookup()

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

#include <include/settings/settings.h>

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

Parameters
[in]namein string format
[out]nextremaining 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 <include/settings/settings.h>

Register a backend handler acting as source.

Parameters
csBackend handler node containing handler information.