0.01.00
ot::ThreadTargetTlv Class Reference

This class implements Target EID TLV generation and parsing. More...

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

Inheritance diagram for ot::ThreadTargetTlv:
ot::ThreadTlv ot::Tlv

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...
 
const Ip6::AddressGetTarget (void) const
 This method returns a pointer to the Target EID. More...
 
void SetTarget (const Ip6::Address &aTarget)
 This method sets the Target EID. 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...
 
TlvGetNext (void)
 This method returns a pointer to the next TLV. More...
 
const TlvGetNext (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 Target EID TLV generation and parsing.

Member Function Documentation

§ GetTarget()

const Ip6::Address* ot::ThreadTargetTlv::GetTarget ( void  ) const
inline

This method returns a pointer to the Target EID.

Returns
A pointer to the Target EID.

§ IsValid()

bool ot::ThreadTargetTlv::IsValid ( void  ) const
inline

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

Return values
TRUEIf the TLV appears to be well-formed.
FALSEIf the TLV does not appear to be well-formed.

§ SetTarget()

void ot::ThreadTargetTlv::SetTarget ( const Ip6::Address aTarget)
inline

This method sets the Target EID.

Parameters
[in]aTargetA reference to the Target EID.

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