settings.hpp File Reference

This file includes functions for debugging. More...

#include "openthread-core-config.h"
#include "thread/mle.hpp"

Go to the source code of this file.

Classes
struct	ot::Settings::NetworkInfo
	This structure represents the device's own network information for settings storage. More...
struct	ot::Settings::ParentInfo
	This structure represents the parent information for settings storage. More...
struct	ot::Settings::ChildInfo
	This structure represents the child information for settings storage. More...

Enumerations
enum	{   ot::Settings::kKeyActiveDataset = 0x0001,   ot::Settings::kKeyPendingDataset = 0x0002,   ot::Settings::kKeyNetworkInfo = 0x0003,   ot::Settings::kKeyParentInfo = 0x0004,   ot::Settings::kKeyChildInfo = 0x0005,   ot::Settings::kKeyThreadAutoStart = 0x0006 }
	Rules for updating existing value structures. More...

Detailed Description

This file includes functions for debugging.

Enumeration Type Documentation

anonymous enum

anonymous enum

Rules for updating existing value structures.

1. Modifying existing otPlatSettings* key value fields MUST only be done by appending new fields. Existing fields MUST NOT be deleted or modified in any way.
2. To support backward compatibility (rolling back to an older software version), code reading and processing key values MUST process key values that have longer length. Additionally, newer versions MUST update/maintain values in existing key value fields.
3. To support forward compatibility (rolling forward to a newer software version), code reading and processing key values MUST process key values that have shorter length.
4. New Key IDs may be defined in the future with the understanding that such key values are not backward compatible. This enumeration defines the keys of settings

Enumerator
kKeyActiveDataset	Active Operational Dataset.
kKeyPendingDataset	Pending Operational Dataset.
kKeyNetworkInfo	Thread network information.
kKeyParentInfo	Parent information.
kKeyChildInfo	Child information.
kKeyThreadAutoStart	Auto-start information.