Symbols ![]()
loading...
Files ![]()
loading...
ot::Mle::RouteTlv class
Syntax
class RouteTlv : public Tlv, public TlvInfo<Tlv::kRoute>
{
public:
void Init(void);
bool IsValid(void) const;
uint8_t GetRouterIdSequence(void) const { return mRouterIdSequence; }
void SetRouterIdSequence(uint8_t aSequence) { mRouterIdSequence = aSequence; }
const RouterIdSet &GetRouterIdMask(void) const { return mRouterIdMask; }
void SetRouterIdMask(const RouterIdSet &aRouterIdSet) { mRouterIdMask = aRouterIdSet; }
bool IsRouterIdSet(uint8_t aRouterId) const { return mRouterIdMask.Contains(aRouterId); }
bool IsSingleton(void) const { return IsValid() && (mRouterIdMask.GetNumberOfAllocatedIds() <= 1); }
uint8_t GetRouteDataLength(void) const { return GetLength() - sizeof(mRouterIdSequence) - sizeof(mRouterIdMask); }
void SetRouteDataLength(uint8_t aLength) { SetLength(sizeof(mRouterIdSequence) + sizeof(mRouterIdMask) + aLength); }
uint8_t GetRouteCost(uint8_t aRouterIndex) const { return mRouteData[aRouterIndex] & kRouteCostMask; }
LinkQuality GetLinkQualityIn(uint8_t aRouterIndex) const
{
return static_cast<LinkQuality>((mRouteData[aRouterIndex] & kLinkQualityInMask) >> kLinkQualityInOffset);
}
LinkQuality GetLinkQualityOut(uint8_t aRouterIndex) const
{
return static_cast<LinkQuality>((mRouteData[aRouterIndex] & kLinkQualityOutMask) >> kLinkQualityOutOffset);
}
void SetRouteData(uint8_t aRouterIndex, LinkQuality aLinkQualityIn, LinkQuality aLinkQualityOut, uint8_t aRouteCost)
{
mRouteData[aRouterIndex] = (((aLinkQualityIn << kLinkQualityInOffset) & kLinkQualityInMask) |
((aLinkQualityOut << kLinkQualityOutOffset) & kLinkQualityOutMask) |
((aRouteCost << kRouteCostOffset) & kRouteCostMask));
}
private:
static constexpr uint8_t kLinkQualityOutOffset = 6;
static constexpr uint8_t kLinkQualityOutMask = 3 << kLinkQualityOutOffset;
static constexpr uint8_t kLinkQualityInOffset = 4;
static constexpr uint8_t kLinkQualityInMask = 3 << kLinkQualityInOffset;
static constexpr uint8_t kRouteCostOffset = 0;
static constexpr uint8_t kRouteCostMask = 0xf << kRouteCostOffset;
uint8_t mRouterIdSequence;
RouterIdSet mRouterIdMask;
uint8_t mRouteData[kMaxRouterId + 1];
};
Fields
Field
Declared as
Related Functions
Found 8 other functions taking a RouteTlv
argument:
Function
Description
Determines whether the Router ID Sequence in a received Route TLV is more recent than the current Router ID Sequence being used by `RouterTable`.
Updates the routes based on a received `RouteTlv` from a neighboring router.
Updates the routes on an FTD child based on a received `RouteTlv` from the parent. MUST be called when device is an FTD child and @p aRouteTlv is received from its current parent.
Fills a Route TLV. When @p aNeighbor is not `nullptr`, we limit the number of router entries to `kMaxRoutersInRouteTlvForLinkAccept` when populating `aRouteTlv`, so that the TLV can be appended in a Link Accept message. In this case, we ensure to include router entries associated with @p aNeighbor, leader, and this device itself.
References
Code
Location
Scope
Referrer
Class Tree
ot::Mle::RouteTlv inherits 1 classes and is inherited by 1 classes:
Instances
Instance
Scope
Location
Project