openthread-br  0.3.0-72c0388
Public Member Functions | Public Attributes | List of all members
otbr::Ip6Prefix Class Reference

#include <src/common/types.hpp>

Public Member Functions

 Ip6Prefix (void)
 
void Set (const otIp6Prefix &aPrefix)
 
std::string ToString (void) const
 
void Clear (void)
 
bool IsValid (void) const
 

Public Attributes

Ip6Address mPrefix
 The IPv6 prefix.
 
uint8_t mLength
 The IPv6 prefix length (in bits).
 

Detailed Description

This class represents a Ipv6 prefix.

Constructor & Destructor Documentation

◆ Ip6Prefix()

otbr::Ip6Prefix::Ip6Prefix ( void  )
inline

Default constructor.

Member Function Documentation

◆ Clear()

void otbr::Ip6Prefix::Clear ( void  )
inline

This method clears the Ip6 prefix to be unspecified.

◆ IsValid()

bool otbr::Ip6Prefix::IsValid ( void  ) const
inline

This method returns if the Ip6 prefix is valid.

Returns
If the Ip6 prefix is valid.

◆ Set()

void otbr::Ip6Prefix::Set ( const otIp6Prefix &  aPrefix)

This method sets the Ip6 prefix to an otIp6Prefix value.

Parameters
[in]aPrefixThe otIp6Prefix value to set the Ip6 prefix.

◆ ToString()

std::string otbr::Ip6Prefix::ToString ( void  ) const

This method returns the string representation for the Ip6 prefix.

Returns
The string representation of the Ip6 prefix.

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