This class implements Status TLV generation and parsing. More...

Inheritance diagram for ot::ThreadStatusTlv:

Public Types
enum	Status { kSuccess = 0, kNoAddressAvailable = 1, kTooFewRouters = 2, kHaveChildIdRequest = 3, kParentPartitionChange = 4 }
	Status values. More...

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

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

Status	GetStatus (void) const
	This method returns the Status value. More...

void	SetStatus (Status aStatus)
	This method sets the Status value. 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
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 Status TLV generation and parsing.

Member Enumeration Documentation

Status values.

Enumerator
kSuccess	Success.
kNoAddressAvailable	No address available.
kTooFewRouters	Address Solicit due to too few routers.
kHaveChildIdRequest	Address Solicit due to child ID request.
kParentPartitionChange	Address Solicit due to parent partition change.

Status ot::ThreadStatusTlv::GetStatus ( void ) const

inline

This method returns the Status value.

bool ot::ThreadStatusTlv::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.

void ot::ThreadStatusTlv::SetStatus ( Status aStatus )

inline

This method sets the Status value.

Parameters

[in] aStatus The Status value.

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