espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-06 10:47:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[settings] remove unused APIs (#3160)

Browse Source
This commit is contained in:
Yakun Xu
2018-10-16 19:57:09 -07:00
committed by Jonathan Hui
parent 3fc9b95f81
commit 0b18d8ffad
1 changed files with 0 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/platform/settings.h
-69
View File
@@ -60,75 +60,6 @@ extern "C" {
*/
void otPlatSettingsInit(otInstance *aInstance);
/// Begin atomic change set
/** This function is called at the start of a sequence of changes
* that should be made atomically.
*
* This function, along with `otPlatSettingsCommitChange()` are designed
* to ensure atomicity of changes to multiple settings. Once
* this function has been called, any changes made to the settings
* store are only committed when `otPlatSettingsCommitChange()` is
* called.
*
* The implementation of this function is optional. If not
* implemented, it should return OT_ERROR_NONE.
*
* @param[in] aInstance
* The OpenThread instance structure.
*
* @retval OT_ERROR_NONE The settings commit lock has been set.
* @retval OT_ERROR_ALREADY The commit lock is already set.
*
* @sa otPlatSettingsCommitChange(), otPlatSettingsAbandonChange()
*/
otError otPlatSettingsBeginChange(otInstance *aInstance);
/// Commit all settings changes since previous call to otPlatSettingsBeginChange()
/** This function is called at the end of a sequence of changes.
* The implementation of this function is optional. If not
* implemented, it should return OT_ERROR_NOT_IMPLEMENTED.
*
* @param[in] aInstance
* The OpenThread instance structure.
*
* @retval OT_ERROR_NONE
* The changes made since the last call to
* otPlatSettingsBeginChange() have been successfully
* committed.
* @retval OT_ERROR_INVALID_STATE
* otPlatSettingsBeginChange() has not been called.
* @retval OT_ERROR_NOT_IMPLEMENTED
* This function is not implemented on this platform.
*
* @sa otPlatSettingsBeginChange(), otPlatSettingsAbandonChange()
*/
otError otPlatSettingsCommitChange(otInstance *aInstance);
/// Abandon all settings changes since previous call to otPlatSettingsBeginChange()
/** This function may be called at the end of a sequence of changes.
* instead of otPlatSettingsCommitChange(). If implemented, it
* causes all changes made since otPlatSettingsBeginChange() to be
* rolled back and abandoned.
*
* The implementation of this function is optional. If not
* implemented, it should return OT_ERROR_NOT_IMPLEMENTED.
*
* @param[in] aInstance
* The OpenThread instance structure.
*
* @retval OT_ERROR_NONE
* The changes made since the last call to
* otPlatSettingsBeginChange() have been successfully
* rolled back.
* @retval OT_ERROR_INVALID_STATE
* otPlatSettingsBeginChange() has not been called.
* @retval OT_ERROR_NOT_IMPLEMENTED
* This function is not implemented on this platform.
*
* @sa otPlatSettingsBeginChange(), otPlatSettingsCommitChange()
*/
otError otPlatSettingsAbandonChange(otInstance *aInstance);
/// Fetches the value of a setting
/** This function fetches the value of the setting identified
* by aKey and write it to the memory pointed to by aValue.