Symbols ![]()
loading (4/5)...
Files ![]()
loading (4/5)...
ot::MeshCoP::Dataset class
Represents MeshCop Dataset.
Syntax
class Dataset
{
friend class DatasetManager;
public:
static constexpr uint8_t kMaxLength = OT_OPERATIONAL_DATASET_MAX_LENGTH;
enum Type : uint8_t
{
kActive,
kPending,
};
typedef otOperationalDatasetTlvs Tlvs;
enum Component : uint8_t
{
kActiveTimestamp,
kPendingTimestamp,
kNetworkKey,
kNetworkName,
kExtendedPanId,
kMeshLocalPrefix,
kDelay,
kPanId,
kChannel,
kWakeupChannel,
kPskc,
kSecurityPolicy,
kChannelMask,
};
template <Component kComponent> struct TypeFor;
class Info;
class Components : public otOperationalDatasetComponents, public Clearable<Components>
{
friend class Info;
public:
template <Component kComponent> bool IsPresent(void) const;
private:
template <Component kComponent> void MarkAsPresent(void);
};
class Info : public otOperationalDataset, public Clearable<Info>
{
public:
template <Component kComponent> bool IsPresent(void) const { return GetComponents().IsPresent<kComponent>(); }
template <Component kComponent> const typename TypeFor<kComponent>::Type &Get(void) const;
template <Component kComponent> void Get(typename TypeFor<kComponent>::Type &aComponent) const;
template <Component kComponent> void Set(const typename TypeFor<kComponent>::Type &aComponent)
{
GetComponents().MarkAsPresent<kComponent>();
AsNonConst(Get<kComponent>()) = aComponent;
}
template <Component kComponent> typename TypeFor<kComponent>::Type &Update(void)
{
GetComponents().MarkAsPresent<kComponent>();
return AsNonConst(Get<kComponent>());
}
Error GenerateRandom(Instance &aInstance);
private:
Components &GetComponents(void) { return static_cast<Components &>(mComponents); }
const Components &GetComponents(void) const { return static_cast<const Components &>(mComponents); }
};
Dataset(void);
void Clear(void) { mLength = 0; }
Error ValidateTlvs(void) const;
static bool IsTlvValid(const Tlv &aTlv);
bool ContainsTlv(Tlv::Type aType) const { return (FindTlv(aType) != nullptr); }
template <typename TlvType> bool Contains(void) const
{
return ContainsTlv(static_cast<Tlv::Type>(TlvType::kType));
}
bool ContainsAllTlvs(const Tlv::Type aTlvTypes[], uint8_t aLength) const;
bool ContainsAllRequiredTlvsFor(Type aType) const;
Tlv *FindTlv(Tlv::Type aType) { return AsNonConst(AsConst(this)->FindTlv(aType)); }
const Tlv *FindTlv(Tlv::Type aType) const;
template <typename SimpleTlvType> Error Read(typename SimpleTlvType::ValueType &aValue) const
{
const Tlv *tlv = FindTlv(static_cast<Tlv::Type>(SimpleTlvType::kType));
return (tlv == nullptr) ? kErrorNotFound : (aValue = tlv->ReadValueAs<SimpleTlvType>(), kErrorNone);
}
template <typename UintTlvType> Error Read(typename UintTlvType::UintValueType &aValue) const
{
const Tlv *tlv = FindTlv(static_cast<Tlv::Type>(UintTlvType::kType));
return (tlv == nullptr) ? kErrorNotFound : (aValue = tlv->ReadValueAs<UintTlvType>(), kErrorNone);
}
Error WriteTlv(const Tlv &aTlv);
Error WriteTlv(Tlv::Type aType, const void *aValue, uint8_t aLength);
template <typename SimpleTlvType> Error Write(const typename SimpleTlvType::ValueType &aValue)
{
return WriteTlv(static_cast<Tlv::Type>(SimpleTlvType::kType), &aValue, sizeof(aValue));
}
template <typename UintTlvType> Error Write(typename UintTlvType::UintValueType aValue)
{
typename UintTlvType::UintValueType value = BigEndian::HostSwap(aValue);
return WriteTlv(static_cast<Tlv::Type>(UintTlvType::kType), &value, sizeof(value));
}
Error WriteTlvsFrom(const Dataset &aDataset);
Error WriteTlvsFrom(const uint8_t *aTlvs, uint8_t aLength);
Error WriteTlvsFrom(const Dataset::Info &aDatasetInfo);
Error AppendTlvsFrom(const uint8_t *aTlvs, uint8_t aLength);
void RemoveTlv(Tlv::Type aType);
Error ReadTimestamp(Type aType, Timestamp &aTimestamp) const;
Error WriteTimestamp(Type aType, const Timestamp &aTimestamp);
void RemoveTimestamp(Type aType);
uint8_t *GetBytes(void) { return mTlvs; }
const uint8_t *GetBytes(void) const { return mTlvs; }
void ConvertTo(Info &aDatasetInfo) const;
void ConvertTo(Tlvs &aTlvs) const;
uint8_t GetLength(void) const { return mLength; }
void SetLength(uint8_t aLength) { mLength = aLength; }
TimeMilli GetUpdateTime(void) const { return mUpdateTime; }
void SetFrom(const Dataset &aDataset);
void SetFrom(const Info &aDatasetInfo);
Error SetFrom(const Tlvs &aTlvs);
Error SetFrom(const uint8_t *aTlvs, uint8_t aLength);
Error SetFrom(const Message &aMessage, const OffsetRange &aOffsetRange);
Tlv *GetTlvsStart(void) { return reinterpret_cast<Tlv *>(mTlvs); }
const Tlv *GetTlvsStart(void) const { return reinterpret_cast<const Tlv *>(mTlvs); }
Tlv *GetTlvsEnd(void) { return reinterpret_cast<Tlv *>(mTlvs + mLength); }
const Tlv *GetTlvsEnd(void) const { return reinterpret_cast<const Tlv *>(mTlvs + mLength); }
bool IsSubsetOf(const Dataset &aOther) const;
static const char *TypeToString(Type aType);
private:
void RemoveTlv(Tlv *aTlv);
static Tlv::Type TimestampTlvFor(Type aType)
{
return (aType == kActive) ? Tlv::kActiveTimestamp : Tlv::kPendingTimestamp;
}
uint8_t mTlvs[kMaxLength];
uint8_t mLength;
TimeMilli mUpdateTime;
};
Fields
Related Functions
Found 11 other functions taking a Dataset
argument:
Function
Description
Sets this Dataset using an existing Dataset.
Retrieves the dataset from non-volatile memory.
Writes TLVs parsed from a given Dataset into this Dataset. TLVs from @p aDataset are parsed and written in the current Dataset. If the same TLV already exists, it will be replaced. Otherwise, the TLV will be appended.
Saves the Operational Dataset in non-volatile memory.
Determines whether this Dataset is a subset of another Dataset. The Dataset is considered a subset if all of its TLVs, excluding Active/Pending Timestamp and Delay Timer TLVs, are present in the @p aOther Dataset and the TLV values match exactly.
Saves the Operational Dataset (active or pending).
Reads the Operational Dataset (active or pending).
References
Code
Location
Scope
Referrer
Instances
Instance
Scope
Location
Project