Symbols ![]()
loading (1/5)...
Files ![]()
loading (4/5)...
ot::Dns::TxtEntry class
Represents a TXT record entry representing a key/value pair (RFC 6763 - section 6.3).
Syntax
class TxtEntry : public otDnsTxtEntry
{
friend class TxtRecord;
public:
static constexpr uint8_t kMinKeyLength = OT_DNS_TXT_KEY_MIN_LENGTH;
static constexpr uint8_t kMaxKeyLength = OT_DNS_TXT_KEY_MAX_LENGTH;
static constexpr uint8_t kMaxIterKeyLength = OT_DNS_TXT_KEY_ITER_MAX_LENGTH;
class Iterator : public otDnsTxtEntryIterator
{
friend class TxtEntry;
public:
void Init(const uint8_t *aTxtData, uint16_t aTxtDataLength);
Error GetNextEntry(TxtEntry &aEntry);
private:
static constexpr uint8_t kIndexTxtLength = 0;
static constexpr uint8_t kIndexTxtPosition = 1;
const char *GetTxtData(void) const { return reinterpret_cast<const char *>(mPtr); }
void SetTxtData(const uint8_t *aTxtData) { mPtr = aTxtData; }
uint16_t GetTxtDataLength(void) const { return mData[kIndexTxtLength]; }
void SetTxtDataLength(uint16_t aLength) { mData[kIndexTxtLength] = aLength; }
uint16_t GetTxtDataPosition(void) const { return mData[kIndexTxtPosition]; }
void SetTxtDataPosition(uint16_t aValue) { mData[kIndexTxtPosition] = aValue; }
void IncreaseTxtDataPosition(uint16_t aIncrement) { mData[kIndexTxtPosition] += aIncrement; }
char *GetKeyBuffer(void) { return mChar; }
const char *GetTxtDataEnd(void) const { return GetTxtData() + GetTxtDataLength(); }
};
TxtEntry(void) = default;
TxtEntry(const char *aKey, const uint8_t *aValue, uint8_t aValueLength) { Init(aKey, aValue, aValueLength); }
void Init(const char *aKey, const uint8_t *aValue, uint8_t aValueLength)
{
mKey = aKey;
mValue = aValue;
mValueLength = aValueLength;
}
Error AppendTo(Message &aMessage) const;
static Error AppendEntries(const TxtEntry *aEntries, uint16_t aNumEntries, Message &aMessage);
static Error AppendEntries(const TxtEntry *aEntries, uint16_t aNumEntries, MutableData<kWithUint16Length> &aData);
private:
Error AppendTo(Appender &aAppender) const;
static Error AppendEntries(const TxtEntry *aEntries, uint16_t aNumEntries, Appender &aAppender);
static constexpr uint8_t kMaxKeyValueEncodedSize = 255;
static constexpr char kKeyValueSeparator = '=';
};
Fields
Field
Description
Minimum length of key string (RFC 6763 - section 6.4).
Recommended max length of key string (RFC 6763 - section 6.4).
Maximum length of TXT key string supported by `Iterator`. This is selected to be longer than recommended `kMaxKeyLength` to handle cases where longer keys are used.
Related Functions
Found 2 other functions taking a TxtEntry
argument:
Function
Description
Appends an array of `TxtEntry` items to a message.
Parses the TXT data from the `Iterator` and gets the next TXT record entry (key/value pair). The `Iterator` instance MUST be initialized using `Init()` before calling this method and the TXT data buffer used to initialize the iterator MUST persist and remain unchanged. If the parsed key string length is smaller than or equal to `kMaxIterKeyLength` the key string is returned in `mKey` in @p aEntry. But if the key is longer, then `mKey` is set to `nullptr` the entire encoded TXT entry is returned in `mValue` and `mValueLength`.
References
Code
Location
Scope
Referrer
Instances
Instance
Scope
Location
Project