ot::ThreadRouterMaskTlv Class Reference

This class implements Router Mask TLV generation and parsing. More...

#include <src/core/thread/thread_tlvs.hpp>

Inheritance diagram for ot::ThreadRouterMaskTlv:

Public Member Functions
void	Init (void)
	This method initializes the TLV.
bool	IsValid (void) const
	This method indicates whether or not the TLV appears to be well-formed. More...
uint8_t	GetIdSequence (void) const
	This method returns the ID Sequence value. More...
void	SetIdSequence (uint8_t aSequence)
	This method sets the ID Sequence value. More...
void	ClearAssignedRouterIdMask (void)
	This method clears the Assigned Router ID Mask.
bool	IsAssignedRouterIdSet (uint8_t aRouterId) const
	This method indicates whether or not a given Router ID is set in the Assigned Router ID Mask. More...
void	SetAssignedRouterId (uint8_t aRouterId)
	This method clears the Assigned Router ID Mask. More...
Public Member Functions inherited from ot::ThreadTlv
Type	GetType (void) const
	This method returns the Type value. More...
void	SetType (Type aType)
	This method sets the Type value. More...
Public Member Functions inherited from ot::Tlv
	Tlv (void)
	Default constructor.
uint8_t	GetType (void) const
	This method returns the Type value. More...
void	SetType (uint8_t aType)
	This method sets the Type value. More...
uint8_t	GetLength (void) const
	This method returns the Length value. More...
void	SetLength (uint8_t aLength)
	This method sets the Length value. More...
uint8_t	GetSize (void) const
	This method returns the total size including Type, Length, and Value fields. More...
uint8_t *	GetValue (void)
	This method returns a pointer to the Value. More...
const uint8_t *	GetValue (void) const
	This method returns a pointer to the Value. More...
Tlv *	GetNext (void)
	This method returns a pointer to the next TLV. More...
const Tlv *	GetNext (void) const
	This method returns a pointer to the next TLV. More...

Additional Inherited Members
Public Types inherited from ot::ThreadTlv
enum	Type {   kTarget = 0,   kExtMacAddress = 1,   kRloc16 = 2,   kMeshLocalEid = 3,   kStatus = 4,   kLastTransactionTime = 6,   kRouterMask = 7,   kNDOption = 8,   kNDData = 9,   kThreadNetworkData = 10 }
	Network Layer TLV Types. More...
Static Public Member Functions inherited from ot::ThreadTlv
static otError	GetTlv (const Message &aMessage, Type aType, uint16_t aMaxLength, Tlv &aTlv)
	This static method reads the requested TLV out of aMessage. More...
Static Public Member Functions inherited from ot::Tlv
static otError	Get (const Message &aMessage, uint8_t aType, uint16_t aMaxLength, Tlv &aTlv)
	This static method reads the requested TLV out of aMessage. More...
static otError	GetOffset (const Message &aMessage, uint8_t aType, uint16_t &aOffset)
	This static method obtains the offset of a TLV within aMessage. More...
static otError	GetValueOffset (const Message &aMesasge, uint8_t aType, uint16_t &aOffset, uint16_t &aLength)
	This static method finds the offset and length of a given TLV type. More...
Protected Types inherited from ot::Tlv
enum	{ kExtendedLength = 255 }
	Length values. More...

Detailed Description

This class implements Router Mask TLV generation and parsing.

Member Function Documentation

GetIdSequence()

uint8_t ot::ThreadRouterMaskTlv::GetIdSequence ( void  ) const

inline

This method returns the ID Sequence value.

Returns

The ID Sequence value.

IsAssignedRouterIdSet()

bool ot::ThreadRouterMaskTlv::IsAssignedRouterIdSet ( uint8_t  aRouterId ) const

inline

This method indicates whether or not a given Router ID is set in the Assigned Router ID Mask.

Parameters

[in]

aRouterId

The Router ID.

Return values

TRUE	If the given Router ID is set in the Assigned Router ID Mask.
FALSE	If the given Router ID is not set in the Assigned Router ID Mask.

IsValid()

bool ot::ThreadRouterMaskTlv::IsValid ( void  ) const

inline

This method indicates whether or not the TLV appears to be well-formed.

Return values

TRUE	If the TLV appears to be well-formed.
FALSE	If the TLV does not appear to be well-formed.

SetAssignedRouterId()

void ot::ThreadRouterMaskTlv::SetAssignedRouterId ( uint8_t  aRouterId )

inline

This method clears the Assigned Router ID Mask.

Parameters

[in]

aRouterId

The Router ID.

SetIdSequence()

void ot::ThreadRouterMaskTlv::SetIdSequence ( uint8_t  aSequence )

inline

This method sets the ID Sequence value.

Parameters

[in]

aSequence

The ID Sequence value.

---

The documentation for this class was generated from the following file:

• src/core/thread/thread_tlvs.hpp