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

[dataset] highlight SetTlv<ValueType>() specializations in the docs (#9534)

Browse Source 
This commit updates the `Dataset::SetTlv<ValueType>()` documentation
to mention its specifications for `uint` types (which use big-endian
encoding). It also adds `static_assert` checks to ensure that the
general template implementation is not used with `uint16/32/64`
types.
This commit is contained in:
Abtin Keshavarzian
2023-10-16 11:31:45 -07:00
committed by GitHub
parent 6bc02986f0
commit ee82a5728a
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/meshcop/dataset.hpp
+6
View File
@@ -770,6 +770,9 @@ public:
*
* @tparam ValueType The type of TLV's Value.
*
* Specializations of this template method are provided for `uint16_t` and `uint32_t` types which ensure big-endian
* encoding is used.
*
* @param[in] aType The TLV Type.
* @param[in] aValue The TLV Value (of type `ValueType`).
*
@@ -780,6 +783,9 @@ public:
template <typename ValueType> Error SetTlv(Tlv::Type aType, const ValueType &aValue)
{
static_assert(!TypeTraits::IsPointer<ValueType>::kValue, "ValueType must not be a pointer");
static_assert(!TypeTraits::IsSame<ValueType, uint16_t>::kValue, "Specialization must be used for uint16_t");
static_assert(!TypeTraits::IsSame<ValueType, uint32_t>::kValue, "Specialization must be used for uint32_t");
static_assert(!TypeTraits::IsSame<ValueType, uint64_t>::kValue, "Specialization must be used for uint64_t");
return SetTlv(aType, &aValue, sizeof(ValueType));
}