espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-18 08:29:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

[netdata] reorder methods under NetworkData::Service (#11814)

Browse Source 
This commit reorders method implementations in the source file
`network_data_service.cpp` to group them within their respective
`Iterator` and `Manager` class sections.

In PR #11680, the `Iterator` class was enhanced to be a separate class
from `Manager`. The method definitions in the `.cpp` file were kept
in their original order at that time to simplify the review by
keeping the `git diff` smaller.

Separator comments are also added to both the `.cpp` and `.hpp` files
to improve code structure and readability.

No functional changes are introduced.
This commit is contained in:
Abtin Keshavarzian
2025-08-13 10:22:42 -07:00
committed by GitHub
parent ed95672bc0
commit a1ad5d23ef
2 changed files with 164 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/thread/network_data_service.cpp
+153 -144
View File
@@ -39,6 +39,9 @@ namespace ot {
namespace NetworkData {
namespace Service {
//----------------------------------------------------------------------------------------------------------------------
// Iterator
Iterator::Iterator(Instance &aInstance)
: Iterator(aInstance, aInstance.Get<Leader>())
{
@@ -58,6 +61,153 @@ void Iterator::Reset(void)
mServerSubTlv = nullptr;
}
Error Iterator::GetNextDnsSrpAnycastInfo(DnsSrpAnycastInfo &aInfo)
{
Error error = kErrorNone;
uint8_t serviceNumber = Manager::kDnsSrpAnycastServiceNumber;
aInfo.Clear();
do
{
ServiceData serviceData;
// Process the next Server sub-TLV in the current Service TLV.
if (AdvanceToNextServer() == kErrorNone)
{
uint8_t dataLength = mServiceTlv->GetServiceDataLength();
if (dataLength >= sizeof(Manager::DnsSrpAnycastServiceData))
{
const Manager::DnsSrpAnycastServiceData *anycastData =
reinterpret_cast<const Manager::DnsSrpAnycastServiceData *>(mServiceTlv->GetServiceData());
Get<Mle::Mle>().GetServiceAloc(mServiceTlv->GetServiceId(), aInfo.mAnycastAddress);
aInfo.mSequenceNumber = anycastData->GetSequenceNumber();
aInfo.mRloc16 = mServerSubTlv->GetServer16();
aInfo.mVersion =
(mServerSubTlv->GetServerDataLength() >= sizeof(uint8_t)) ? *mServerSubTlv->GetServerData() : 0;
ExitNow();
}
}
// Find the next matching Service TLV.
serviceData.InitFrom(serviceNumber);
mServiceTlv = mNetworkData.FindNextThreadService(mServiceTlv, serviceData, NetworkData::kServicePrefixMatch);
mServerSubTlv = nullptr;
// If we have a valid Service TLV, restart the loop
// to process its Server sub-TLVs.
} while (mServiceTlv != nullptr);
error = kErrorNotFound;
exit:
return error;
}
Error Iterator::GetNextDnsSrpUnicastInfo(DnsSrpUnicastType aType, DnsSrpUnicastInfo &aInfo)
{
Error error = kErrorNone;
uint8_t serviceNumber = Manager::kDnsSrpUnicastServiceNumber;
aInfo.Clear();
do
{
ServiceData serviceData;
// Process Server sub-TLVs in the current Service TLV.
while (AdvanceToNextServer() == kErrorNone)
{
aInfo.mRloc16 = mServerSubTlv->GetServer16();
if (aType == kAddrInServiceData)
{
if (Manager::DnsSrpUnicast::ServiceData::ParseFrom(*mServiceTlv, aInfo) == kErrorNone)
{
ExitNow();
}
// If Service Data does not contain address info, we
// break from `while (IterateToNextServer())` loop
// to skip over the entire Service TLV and all its
// sub-TLVs and go to the next one.
break;
}
// `aType` is `kAddrInServerData`.
// Server sub-TLV can contain address and port info
// (then we parse and return the info), or it can be
// empty (then we skip over it).
if (Manager::DnsSrpUnicast::ServerData::ParseFrom(*mServerSubTlv, aInfo) == kErrorNone)
{
ExitNow();
}
if (mServerSubTlv->GetServerDataLength() == sizeof(uint16_t))
{
// Handle the case where the server TLV data only
// contains a port number and use the RLOC as the
// IPv6 address.
aInfo.mSockAddr.GetAddress().SetToRoutingLocator(Get<Mle::Mle>().GetMeshLocalPrefix(),
mServerSubTlv->GetServer16());
aInfo.mSockAddr.SetPort(BigEndian::ReadUint16(mServerSubTlv->GetServerData()));
aInfo.mVersion = 0;
ExitNow();
}
}
// Find the next matching Service TLV.
serviceData.InitFrom(serviceNumber);
mServiceTlv = mNetworkData.FindNextThreadService(mServiceTlv, serviceData, NetworkData::kServicePrefixMatch);
mServerSubTlv = nullptr;
// If we have a valid Service TLV, restart the loop
// to process its Server sub-TLVs.
} while (mServiceTlv != nullptr);
error = kErrorNotFound;
exit:
return error;
}
Error Iterator::AdvanceToNextServer(void)
{
Error error = kErrorNotFound;
const NetworkDataTlv *start;
const NetworkDataTlv *end;
VerifyOrExit(mServiceTlv != nullptr);
start = (mServerSubTlv != nullptr) ? mServerSubTlv->GetNext() : mServiceTlv->GetSubTlvs();
end = mServiceTlv->GetNext();
mServerSubTlv = NetworkDataTlv::Find<ServerTlv>(start, end);
if (mServerSubTlv != nullptr)
{
error = kErrorNone;
}
exit:
return error;
}
//----------------------------------------------------------------------------------------------------------------------
// Manager
#if OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
Error Manager::AddDnsSrpAnycastService(uint8_t aSequenceNumber, uint8_t aVersion)
@@ -176,54 +326,6 @@ exit:
#endif // (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2)
Error Iterator::GetNextDnsSrpAnycastInfo(DnsSrpAnycastInfo &aInfo)
{
Error error = kErrorNone;
uint8_t serviceNumber = Manager::kDnsSrpAnycastServiceNumber;
aInfo.Clear();
do
{
ServiceData serviceData;
// Process the next Server sub-TLV in the current Service TLV.
if (AdvanceToNextServer() == kErrorNone)
{
uint8_t dataLength = mServiceTlv->GetServiceDataLength();
if (dataLength >= sizeof(Manager::DnsSrpAnycastServiceData))
{
const Manager::DnsSrpAnycastServiceData *anycastData =
reinterpret_cast<const Manager::DnsSrpAnycastServiceData *>(mServiceTlv->GetServiceData());
Get<Mle::Mle>().GetServiceAloc(mServiceTlv->GetServiceId(), aInfo.mAnycastAddress);
aInfo.mSequenceNumber = anycastData->GetSequenceNumber();
aInfo.mRloc16 = mServerSubTlv->GetServer16();
aInfo.mVersion =
(mServerSubTlv->GetServerDataLength() >= sizeof(uint8_t)) ? *mServerSubTlv->GetServerData() : 0;
ExitNow();
}
}
// Find the next matching Service TLV.
serviceData.InitFrom(serviceNumber);
mServiceTlv = mNetworkData.FindNextThreadService(mServiceTlv, serviceData, NetworkData::kServicePrefixMatch);
mServerSubTlv = nullptr;
// If we have a valid Service TLV, restart the loop
// to process its Server sub-TLVs.
} while (mServiceTlv != nullptr);
error = kErrorNotFound;
exit:
return error;
}
Error Manager::FindPreferredDnsSrpAnycastInfo(DnsSrpAnycastInfo &aInfo) const
{
Error error = kErrorNotFound;
@@ -305,6 +407,9 @@ exit:
return error;
}
//----------------------------------------------------------------------------------------------------------------------
// Manager::DnsSrpUnicast::AddrData
Error Manager::DnsSrpUnicast::AddrData::ParseFrom(const uint8_t *aData, uint8_t aLength, DnsSrpUnicastInfo &aInfo)
{
Error error = kErrorNone;
@@ -320,102 +425,6 @@ exit:
return error;
}
Error Iterator::GetNextDnsSrpUnicastInfo(DnsSrpUnicastType aType, DnsSrpUnicastInfo &aInfo)
{
Error error = kErrorNone;
uint8_t serviceNumber = Manager::kDnsSrpUnicastServiceNumber;
aInfo.Clear();
do
{
ServiceData serviceData;
// Process Server sub-TLVs in the current Service TLV.
while (AdvanceToNextServer() == kErrorNone)
{
aInfo.mRloc16 = mServerSubTlv->GetServer16();
if (aType == kAddrInServiceData)
{
if (Manager::DnsSrpUnicast::ServiceData::ParseFrom(*mServiceTlv, aInfo) == kErrorNone)
{
ExitNow();
}
// If Service Data does not contain address info, we
// break from `while (IterateToNextServer())` loop
// to skip over the entire Service TLV and all its
// sub-TLVs and go to the next one.
break;
}
// `aType` is `kAddrInServerData`.
// Server sub-TLV can contain address and port info
// (then we parse and return the info), or it can be
// empty (then we skip over it).
if (Manager::DnsSrpUnicast::ServerData::ParseFrom(*mServerSubTlv, aInfo) == kErrorNone)
{
ExitNow();
}
if (mServerSubTlv->GetServerDataLength() == sizeof(uint16_t))
{
// Handle the case where the server TLV data only
// contains a port number and use the RLOC as the
// IPv6 address.
aInfo.mSockAddr.GetAddress().SetToRoutingLocator(Get<Mle::Mle>().GetMeshLocalPrefix(),
mServerSubTlv->GetServer16());
aInfo.mSockAddr.SetPort(BigEndian::ReadUint16(mServerSubTlv->GetServerData()));
aInfo.mVersion = 0;
ExitNow();
}
}
// Find the next matching Service TLV.
serviceData.InitFrom(serviceNumber);
mServiceTlv = mNetworkData.FindNextThreadService(mServiceTlv, serviceData, NetworkData::kServicePrefixMatch);
mServerSubTlv = nullptr;
// If we have a valid Service TLV, restart the loop
// to process its Server sub-TLVs.
} while (mServiceTlv != nullptr);
error = kErrorNotFound;
exit:
return error;
}
Error Iterator::AdvanceToNextServer(void)
{
Error error = kErrorNotFound;
const NetworkDataTlv *start;
const NetworkDataTlv *end;
VerifyOrExit(mServiceTlv != nullptr);
start = (mServerSubTlv != nullptr) ? mServerSubTlv->GetNext() : mServiceTlv->GetSubTlvs();
end = mServiceTlv->GetNext();
mServerSubTlv = NetworkDataTlv::Find<ServerTlv>(start, end);
if (mServerSubTlv != nullptr)
{
error = kErrorNone;
}
exit:
return error;
}
} // namespace Service
} // namespace NetworkData
} // namespace ot
src/core/thread/network_data_service.hpp
+11 -1
View File
@@ -319,6 +319,8 @@ private:
static constexpr uint8_t kDnsSrpAnycastServiceNumber = 0x5c;
static constexpr uint8_t kDnsSrpUnicastServiceNumber = 0x5d;
//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OT_TOOL_PACKED_BEGIN
class DnsSrpAnycastServiceData
{
@@ -338,6 +340,8 @@ private:
uint8_t mSequenceNumber;
} OT_TOOL_PACKED_END;
//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
class DnsSrpUnicast
{
public:
@@ -428,6 +432,8 @@ private:
DnsSrpUnicast(void) = delete;
};
//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#if (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2)
OT_TOOL_PACKED_BEGIN
class BbrServerData
@@ -452,7 +458,10 @@ private:
} OT_TOOL_PACKED_END;
#endif
//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#if OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
template <typename ServiceDataType> Error AddService(const ServiceDataType &aServiceData)
{
return AddService(&aServiceData, aServiceData.GetLength(), nullptr, 0);
@@ -482,7 +491,8 @@ private:
Error RemoveService(uint8_t aServiceNumber) { return RemoveService(&aServiceNumber, sizeof(uint8_t)); }
Error RemoveService(const void *aServiceData, uint8_t aServiceDataLength);
#endif
#endif // OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
Error GetServiceId(uint8_t aServiceNumber, uint8_t &aServiceId) const;