Symbols

loading (3/5)...

Files

loading (4/5)...

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Dns::TxtEntry::Iterator

ot::Dns::TxtEntry::Iterator class

Represents an iterator for TXT record entries (key/value pairs).

Syntax

Show:

Summary

Declaration

from dns_types.hpp:1126

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(); } };

Fields

Field

ot::Dns::TxtEntry::Iterator::kIndexTxtLength

ot::Dns::TxtEntry::Iterator::kIndexTxtPosition

Methods

Init()

Initializes a TXT record iterator. The buffer pointer @p aTxtData and its content MUST persist and remain unchanged while the iterator object is being used.

GetNextEntry()

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`.

GetTxtData() const

SetTxtData()

GetTxtDataLength() const

SetTxtDataLength()

GetTxtDataPosition() const

SetTxtDataPosition()

IncreaseTxtDataPosition()

GetKeyBuffer()

GetTxtDataEnd() const

References

Code

Location

Scope

Referrer

class Iterator : public otDnsTxtEntryIterator

dns_types.hpp:1126

DefineCoreType(otCacheEntryIterator, AddressResolver::Iterator);

address_resolver.hpp:400

DefineCoreType(otCacheEntryInfo, AddressResolver::EntryInfo);

address_resolver.hpp:401

DefineCoreType(otBorderAgentId, MeshCoP::BorderAgent::Id);

border_agent.hpp:353

DefineCoreType(otChildInfo, Child::Info);

DefineCoreType(otCoapTxParameters, Coap::TxParameters);

DefineCoreType(otCoapResource, Coap::Resource);

DefineCoreType(otCoapOption, Coap::Option);

coap_message.hpp:1175

DefineCoreType(otCoapOptionIterator, Coap::Option::Iterator);

coap_message.hpp:1176

DefineCoreType(otOperationalDatasetComponents, MeshCoP::Dataset::Components);

dataset.hpp:783

DefineCoreType(otOperationalDataset, MeshCoP::Dataset::Info);

dataset.hpp:784

DefineCoreType(otDnsQueryConfig, Dns::Client::QueryConfig);

dns_client.hpp:892

DefineCoreType(otDnsAddressResponse, Dns::Client::AddressResponse);

dns_client.hpp:893

DefineCoreType(otDnsBrowseResponse, Dns::Client::BrowseResponse);

dns_client.hpp:895

DefineCoreType(otDnsServiceResponse, Dns::Client::ServiceResponse);

dns_client.hpp:896

DefineCoreType(otDnsServiceInfo, Dns::Client::ServiceInfo);

dns_client.hpp:897

DefineCoreType(otDnsTxtEntry, Dns::TxtEntry);

dns_types.hpp:2734

DefineCoreType(otDnsTxtEntryIterator, Dns::TxtEntry::Iterator);

dns_types.hpp:2735

DefineCoreType(otPlatCryptoEcdsaSignature, Crypto::Ecdsa::P256::Signature);

DefineCoreType(otPlatCryptoEcdsaKeyPair, Crypto::Ecdsa::P256::KeyPair);

DefineCoreType(otPlatCryptoEcdsaPublicKey, Crypto::Ecdsa::P256::PublicKey);

DefineCoreType(otExtendedPanId, MeshCoP::ExtendedPanId);

extended_panid.hpp:106

DefineCoreType(otIcmp6Header, Ip6::Icmp::Header);

DefineCoreType(otIcmp6Handler, Ip6::Icmp::Handler);

DefineCoreType(otInstance, Instance);

instance.hpp:741

DefineCoreType(otBufferInfo, Instance::BufferInfo);

instance.hpp:742

DefineCoreType(otIp4Address, Ip4::Address);

ip4_types.hpp:661

DefineCoreType(otIp4Cidr, Ip4::Cidr);

ip4_types.hpp:662

DefineCoreType(otIp6NetworkPrefix, Ip6::NetworkPrefix);

ip6_address.hpp:986

DefineCoreType(otIp6Prefix, Ip6::Prefix);

ip6_address.hpp:987

DefineCoreType(otIp6InterfaceIdentifier, Ip6::InterfaceIdentifier);

ip6_address.hpp:988

DefineCoreType(otIp6Address, Ip6::Address);

ip6_address.hpp:989

DefineCoreType(otSecurityPolicy, SecurityPolicy);

key_manager.hpp:646

DefineCoreType(otNetworkKey, NetworkKey);

key_manager.hpp:647

DefineCoreType(otPskc, Pskc);

key_manager.hpp:648

DefineCoreType(otExtAddress, Mac::ExtAddress);

mac_types.hpp:923

DefineCoreType(otMacKey, Mac::Key);

mac_types.hpp:924

DefineCoreType(otMeshDiagIp6AddrIterator, Utils::MeshDiag::Ip6AddrIterator);

mesh_diag.hpp:314

DefineCoreType(otMeshDiagRouterInfo, Utils::MeshDiag::RouterInfo);

mesh_diag.hpp:315

DefineCoreType(otMeshDiagChildInfo, Utils::MeshDiag::ChildInfo);

mesh_diag.hpp:316

DefineCoreType(otMeshDiagChildIterator, Utils::MeshDiag::ChildIterator);

mesh_diag.hpp:317

DefineCoreType(otThreadLinkInfo, ThreadLinkInfo);

mesh_forwarder.hpp:662

DefineCoreType(otJoinerPskd, MeshCoP::JoinerPskd);

meshcop.hpp:515

DefineCoreType(otJoinerDiscerner, MeshCoP::JoinerDiscerner);

meshcop.hpp:516

DefineCoreType(otSteeringData, MeshCoP::SteeringData);

meshcop.hpp:517

DefineCoreType(otCommissioningDataset, MeshCoP::CommissioningDataset);

meshcop.hpp:518

DefineCoreType(otMessageBuffer, Buffer);

message.hpp:1901

DefineCoreType(otMessageSettings, Message::Settings);

message.hpp:1902

DefineCoreType(otMessage, Message);

message.hpp:1903

DefineCoreType(otMessageQueue, MessageQueue);

message.hpp:1904

DefineCoreType(otLeaderData, Mle::LeaderData);

mle_types.hpp:699

DefineCoreType(otDeviceProperties, Mle::DeviceProperties);

mle_types.hpp:702

DefineCoreType(otNeighborInfo, Neighbor::Info);

neighbor.hpp:773

DefineCoreType(otNetifAddress, Ip6::Netif::UnicastAddress);

DefineCoreType(otNetifMulticastAddress, Ip6::Netif::MulticastAddress);

DefineCoreType(otBorderRouterConfig, NetworkData::OnMeshPrefixConfig);

network_data_types.hpp:400

DefineCoreType(otExternalRouteConfig, NetworkData::ExternalRouteConfig);

network_data_types.hpp:401

DefineCoreType(otLowpanContextInfo, NetworkData::LowpanContextInfo);

network_data_types.hpp:402

DefineCoreType(otServiceConfig, NetworkData::ServiceConfig);

network_data_types.hpp:403

DefineCoreType(otServerConfig, NetworkData::ServiceConfig::ServerConfig);

network_data_types.hpp:404

DefineCoreType(otNetworkName, MeshCoP::NetworkName);

network_name.hpp:262

DefineCoreType(otPingSenderReply, Utils::PingSender::Reply);

ping_sender.hpp:179

DefineCoreType(otPingSenderConfig, Utils::PingSender::Config);

ping_sender.hpp:180

DefineCoreType(otPingSenderStatistics, Utils::PingSender::Statistics);

ping_sender.hpp:181

DefineCoreType(otRouterInfo, Router::Info);

DefineCoreType(otCryptoSha256Hash, Crypto::Sha256::Hash);

DefineCoreType(otMessageInfo, Ip6::MessageInfo);

DefineCoreType(otSockAddr, Ip6::SockAddr);

DefineCoreType(otSrpClientHostInfo, Srp::Client::HostInfo);

srp_client.hpp:1116

DefineCoreType(otSrpClientService, Srp::Client::Service);

srp_client.hpp:1117

DefineCoreType(otSrpClientBuffersServiceEntry, Utils::SrpClientBuffers::ServiceEntry);

srp_client_buffers.hpp:248

DefineCoreType(otSrpServerTtlConfig, Srp::Server::TtlConfig);

srp_server.hpp:1019

DefineCoreType(otSrpServerLeaseConfig, Srp::Server::LeaseConfig);

srp_server.hpp:1020

DefineCoreType(otSrpServerHost, Srp::Server::Host);

srp_server.hpp:1021

DefineCoreType(otSrpServerService, Srp::Server::Service);

srp_server.hpp:1022

DefineCoreType(otCryptoKey, Crypto::Key);

storage.hpp:323

DefineCoreType(otTcpEndpoint, Ip6::Tcp::Endpoint);

DefineCoreType(otTcpListener, Ip6::Tcp::Listener);

DefineCoreType(otTcpCircularSendBuffer, Ip6::TcpCircularSendBuffer);

tcp6_ext.hpp:129

DefineCoreType(otUdpSocket, Ip6::Udp::SocketHandle);

DefineCoreType(otUdpReceiver, Ip6::Udp::Receiver);

void TxtEntry::Iterator::Init(const uint8_t *aTxtData, uint16_t aTxtDataLength)

dns_types.cpp:1023

ot::Dns::TxtEntry::Iterator::Init()

Error TxtEntry::Iterator::GetNextEntry(TxtEntry &aEntry)

dns_types.cpp:1030

ot::Dns::TxtEntry::Iterator::GetNextEntry()

DefineCoreType(otDnsTxtEntryIterator, Dns::TxtEntry::Iterator);

dns_types.hpp:2735

ot::CoreType::Type

Dns::TxtEntry::Iterator iterator;

trel_interface.cpp:245

ot::Trel::Interface::ParsePeerInfoTxtData() const

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

ot::Dns::TxtEntry::Iterator is inherited by 1 classes:

ot::Dns::TxtEntry::Iterator

otDnsTxtEntryIterator

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Instance

Scope

Location

Project

ot::CoreType::Type

dns_types.hpp:2735

Lifecycle

All items filtered out

All items filtered out