[mynewt-core] branch master updated: sys/config: Expose `conf_lock` and conf_unlock`

[cc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ccollins pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-core.git


The following commit(s) were added to refs/heads/master by this push:
     new 7fef513  sys/config: Expose `conf_lock` and conf_unlock`
7fef513 is described below

commit 7fef513436740e232f0f9694f5e9fad36388e1c9
Author: Christopher Collins <cc...@apache.org>
AuthorDate: Wed Dec 4 10:57:44 2019 -0800

    sys/config: Expose `conf_lock` and conf_unlock`
    
    Prior to this commit, these two functions were private to the config
    package.  This commit moves their prototypes to the public `config.h`
    header.
    
    If another task tries to read or write a setting while the config
    package is locked, the operation will block until the package is
    unlocked.  The locking task is permitted to read and write settings as
    usual.
    
    Typical usage of the config API does not require manual locking.  This
    functionality is only needed for unusual use cases such as temporarily
    changing the destination medium for an isolated series of writes.
---
 sys/config/include/config/config.h | 22 ++++++++++++++++++++++
 sys/config/src/config_priv.h       |  6 ------
 2 files changed, 22 insertions(+), 6 deletions(-)

diff --git a/sys/config/include/config/config.h b/sys/config/include/config/config.h
index a64a3a7..6eb3ffe 100644
--- a/sys/config/include/config/config.h
+++ b/sys/config/include/config/config.h
@@ -355,6 +355,28 @@ char *conf_str_from_bytes(void *vp, int vp_len, char *buf, int buf_len);
 #define CONF_VALUE_SET(str, type, val)                                  \
     conf_value_from_str((str), (type), &(val), sizeof(val))
 
+/**
+ * @brief Locks the config package.
+ *
+ * If another task tries to read or write a setting while the config package is
+ * locked, the operation will block until the package is unlocked.  The locking
+ * task is permitted to read and write settings as usual.  A call to
+ * `conf_lock()` should always be followed by `conf_unlock()`.
+ *
+ * Typical usage of the config API does not require manual locking.
+ * This function is only needed for unusual use cases such as temporarily
+ * changing the destination medium for an isolated series of writes.
+ */
+void conf_lock(void);
+
+/**
+ * @brief Unlocks the config package.
+ *
+ * This function reverts the effects of the `conf_lock()` function.  Typical
+ * usage of the config API does not require manual locking.
+ */
+void conf_unlock(void);
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/sys/config/src/config_priv.h b/sys/config/src/config_priv.h
index d6dfa20..7ae6051 100644
--- a/sys/config/src/config_priv.h
+++ b/sys/config/src/config_priv.h
@@ -27,12 +27,6 @@ extern "C" {
 int conf_cli_register(void);
 int conf_mgmt_register(void);
 
-/*
- * Lock config subsystem.
- */
-void conf_lock(void);
-void conf_unlock(void);
-
 struct mgmt_cbuf;
 int conf_line_parse(char *buf, char **namep, char **valp);
 int conf_line_make(char *dst, int dlen, const char *name, const char *val);