Symbols ![]()
loading...
Files ![]()
loading...
ot::Tlv class
Syntax
class Tlv
{
public:
static constexpr uint8_t kBaseTlvMaxLength = OT_NETWORK_BASE_TLV_MAX_LENGTH;
uint8_t GetType(void) const { return mType; }
void SetType(uint8_t aType) { mType = aType; }
bool IsExtended(void) const { return (mLength == kExtendedLength); }
uint8_t GetLength(void) const { return mLength; }
void SetLength(uint8_t aLength) { mLength = aLength; }
uint32_t GetSize(void) const;
uint8_t *GetValue(void);
const uint8_t *GetValue(void) const;
Tlv *GetNext(void) { return reinterpret_cast<Tlv *>(reinterpret_cast<uint8_t *>(this) + GetSize()); }
const Tlv *GetNext(void) const
{
return reinterpret_cast<const Tlv *>(reinterpret_cast<const uint8_t *>(this) + GetSize());
}
Error AppendTo(Message &aMessage) const;
template <typename SimpleTlvType> const typename SimpleTlvType::ValueType &ReadValueAs(void) const
{
return *reinterpret_cast<const typename SimpleTlvType::ValueType *>(this + 1);
}
template <typename UintTlvType> typename UintTlvType::UintValueType ReadValueAs(void) const
{
return BigEndian::Read<typename UintTlvType::UintValueType>(reinterpret_cast<const uint8_t *>(this + 1));
}
template <typename SimpleTlvType> void WriteValueAs(const typename SimpleTlvType::ValueType &aValue)
{
memcpy(this + 1, &aValue, sizeof(aValue));
}
template <typename UintTlvType> void WriteValueAs(typename UintTlvType::UintValueType aValue)
{
return BigEndian::Write<typename UintTlvType::UintValueType>(aValue, reinterpret_cast<uint8_t *>(this + 1));
}
struct ParsedInfo
{
Error ParseFrom(const Message &aMessage, uint16_t aOffset);
Error ParseFrom(const Message &aMessage, const OffsetRange &aOffsetRange);
Error FindIn(const Message &aMessage, uint8_t aType);
uint16_t GetSize(void) const { return mTlvOffsetRange.GetLength(); }
uint8_t mType;
bool mIsExtended;
OffsetRange mTlvOffsetRange;
OffsetRange mValueOffsetRange;
};
static Error ReadTlvValue(const Message &aMessage, uint16_t aOffset, void *aValue, uint8_t aMinLength);
template <typename SimpleTlvType>
static Error Read(const Message &aMessage, uint16_t aOffset, typename SimpleTlvType::ValueType &aValue)
{
return ReadTlvValue(aMessage, aOffset, &aValue, sizeof(aValue));
}
template <typename UintTlvType>
static Error Read(const Message &aMessage, uint16_t aOffset, typename UintTlvType::UintValueType &aValue)
{
return ReadUintTlv(aMessage, aOffset, aValue);
}
template <typename StringTlvType>
static Error Read(const Message &aMessage, uint16_t aOffset, typename StringTlvType::StringType &aValue)
{
return ReadStringTlv(aMessage, aOffset, StringTlvType::kMaxStringLength, aValue);
}
static Error FindTlv(const Message &aMessage, uint8_t aType, uint16_t aMaxSize, Tlv &aTlv);
static Error FindTlv(const Message &aMessage, uint8_t aType, uint16_t aMaxSize, Tlv &aTlv, uint16_t &aOffset);
template <typename TlvType> static Error FindTlv(const Message &aMessage, TlvType &aTlv)
{
return FindTlv(aMessage, TlvType::kType, sizeof(TlvType), aTlv);
}
template <typename TlvType> static Error FindTlv(const Message &aMessage, TlvType &aTlv, uint16_t &aOffset)
{
return FindTlv(aMessage, TlvType::kType, sizeof(TlvType), aTlv, aOffset);
}
static Error FindTlvValueOffsetRange(const Message &aMessage, uint8_t aType, OffsetRange &aOffsetRange);
template <typename TlvType> static Error Find(const Message &aMessage, void *aValue, uint8_t aLength)
{
return FindTlv(aMessage, TlvType::kType, aValue, aLength);
}
template <typename SimpleTlvType>
static Error Find(const Message &aMessage, typename SimpleTlvType::ValueType &aValue)
{
return FindTlv(aMessage, SimpleTlvType::kType, &aValue, sizeof(aValue));
}
template <typename UintTlvType>
static Error Find(const Message &aMessage, typename UintTlvType::UintValueType &aValue)
{
return FindUintTlv(aMessage, UintTlvType::kType, aValue);
}
template <typename StringTlvType>
static Error Find(const Message &aMessage, typename StringTlvType::StringType &aValue)
{
return FindStringTlv(aMessage, StringTlvType::kType, StringTlvType::kMaxStringLength, aValue);
}
static Error AppendTlv(Message &aMessage, uint8_t aType, const void *aValue, uint16_t aLength);
template <typename TlvType> static Error Append(Message &aMessage, const void *aValue, uint8_t aLength)
{
return AppendTlv(aMessage, TlvType::kType, aValue, aLength);
}
template <typename SimpleTlvType>
static Error Append(Message &aMessage, const typename SimpleTlvType::ValueType &aValue)
{
return AppendTlv(aMessage, SimpleTlvType::kType, &aValue, sizeof(aValue));
}
template <typename UintTlvType> static Error Append(Message &aMessage, typename UintTlvType::UintValueType aValue)
{
return AppendUintTlv(aMessage, UintTlvType::kType, aValue);
}
template <typename StringTlvType> static Error Append(Message &aMessage, const char *aValue)
{
return AppendStringTlv(aMessage, StringTlvType::kType, StringTlvType::kMaxStringLength, aValue);
}
static const Tlv *FindTlv(const void *aTlvsStart, uint16_t aTlvsLength, uint8_t aType);
static Tlv *FindTlv(void *aTlvsStart, uint16_t aTlvsLength, uint8_t aType)
{
return AsNonConst(FindTlv(AsConst(aTlvsStart), aTlvsLength, aType));
}
template <typename TlvType> static TlvType *Find(void *aTlvsStart, uint16_t aTlvsLength)
{
return static_cast<TlvType *>(FindTlv(aTlvsStart, aTlvsLength, TlvType::kType));
}
template <typename TlvType> static const TlvType *Find(const void *aTlvsStart, uint16_t aTlvsLength)
{
return static_cast<const TlvType *>(FindTlv(aTlvsStart, aTlvsLength, TlvType::kType));
}
protected:
static const uint8_t kExtendedLength = 255;
private:
static Error FindTlv(const Message &aMessage, uint8_t aType, void *aValue, uint16_t aLength);
static Error ReadStringTlv(const Message &aMessage, uint16_t aOffset, uint8_t aMaxStringLength, char *aValue);
static Error FindStringTlv(const Message &aMessage, uint8_t aType, uint8_t aMaxStringLength, char *aValue);
static Error AppendStringTlv(Message &aMessage, uint8_t aType, uint8_t aMaxStringLength, const char *aValue);
template <typename UintType> static Error ReadUintTlv(const Message &aMessage, uint16_t aOffset, UintType &aValue);
template <typename UintType> static Error FindUintTlv(const Message &aMessage, uint8_t aType, UintType &aValue);
template <typename UintType> static Error AppendUintTlv(Message &aMessage, uint8_t aType, UintType aValue);
uint8_t mType;
uint8_t mLength;
};
Fields
Field
Description
Declared as
The maximum length of the Base TLV format.
uint8_t
uint8_t