ESP-IDF
ot::Ip6::NetworkPrefix
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading (4/5)...
Files
loading (4/5)...
Summary
Syntax
Methods
Related
Examples
References
Call Tree
Data Use
Class Tree
Override Tree
Implementations
Instances
Lifecycle
SourceVu
ESP-IDF Framework and Examples
ESP-IDF
ot::Ip6::NetworkPrefix
ot::Ip6::NetworkPrefix class
Syntax
Show:
Summary
Declaration
from
ip6_address.hpp:69
class
NetworkPrefix
:
public
otIp6NetworkPrefix
,
public
Equatable
<
NetworkPrefix
>
,
public
Clearable
<
NetworkPrefix
>
{
public
:
static
constexpr
uint8_t
kSize
=
OT_IP6_PREFIX_SIZE
;
static
constexpr
uint8_t
kLength
=
kSize
*
kBitsPerByte
;
Error
GenerateRandomUla
(
void
)
;
}
;
Fields
Field
ot::Ip6::NetworkPrefix::kSize
ot::Ip6::NetworkPrefix::kLength
Methods
GenerateRandomUla()
Generates and sets the Network Prefix to a crypto-secure random Unique Local Address (ULA) based on the pattern `fdxx:xxxx:xxxx:` (RFC 4193).
Related Functions
Found 8 other functions taking a
NetworkPrefix
argument:
Function
Description
ot::Ip6::Address::SetToRoutingLocator()
Sets the IPv6 address to a Routing Locator (RLOC) IPv6 address with a given Network Prefix and RLOC16 value.
ot::Ip6::Address::SetPrefix()
Sets the IPv6 address prefix to the given Network Prefix.
ot::Ip6::Prefix::Set()
Sets the prefix.
ot::Ip6::Address::SetMulticastNetworkPrefix()
Sets the prefix content of the Prefix-Based Multicast Address.
ot::Ip6::Address::SetToLocator()
ot::Dhcp6::Server::PrefixAgent::Set()
Sets the ALOC.
ot::Mle::Mle::SetMeshLocalPrefix()
Sets the Mesh Local Prefix.
ot::Ip6::Address::SetToAnycastLocator()
Sets the IPv6 address to a Anycast Locator (ALOC) IPv6 address with a given Network Prefix and ALOC16 value.
Examples
References
from
examples
Code
Location
Scope
Referrer
class
NetworkPrefix
:
public
otIp6NetworkPrefix
,
public
Equatable
<
NetworkPrefix
>
,
public
Clearable
<
NetworkPrefix
>
ip6_address.hpp:69
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kActiveTimestamp
>
{
using
Type
=
Timestamp
;
}
;
dataset.hpp:700
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kPendingTimestamp
>
{
using
Type
=
Timestamp
;
}
;
dataset.hpp:701
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kNetworkKey
>
{
using
Type
=
NetworkKey
;
}
;
dataset.hpp:702
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kNetworkName
>
{
using
Type
=
NetworkName
;
}
;
dataset.hpp:703
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kExtendedPanId
>
{
using
Type
=
ExtendedPanId
;
}
;
dataset.hpp:704
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kMeshLocalPrefix
>
{
using
Type
=
Ip6
::
NetworkPrefix
;
}
;
dataset.hpp:705
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kDelay
>
{
using
Type
=
uint32_t
;
}
;
dataset.hpp:706
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kPanId
>
{
using
Type
=
Mac
::
PanId
;
}
;
dataset.hpp:707
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kChannel
>
{
using
Type
=
uint16_t
;
}
;
dataset.hpp:708
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kWakeupChannel
>
{
using
Type
=
uint16_t
;
}
;
dataset.hpp:709
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kPskc
>
{
using
Type
=
Pskc
;
}
;
dataset.hpp:710
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kSecurityPolicy
>
{
using
Type
=
SecurityPolicy
;
}
;
dataset.hpp:711
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kChannelMask
>
{
using
Type
=
uint32_t
;
}
;
dataset.hpp:712
DefineCoreType
(
otIp6NetworkPrefix
,
Ip6
::
NetworkPrefix
)
;
ip6_address.hpp:986
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kMeshLocalPrefix
>
{
using
Type
=
Ip6
::
NetworkPrefix
;
}
;
dataset.hpp:705
ot::MeshCoP::Dataset::TypeFor::Type
template
<
>
inline
const
Ip6
::
NetworkPrefix
&
Dataset
::
Info
::
Get
<
Dataset
::
kMeshLocalPrefix
>
(
void
)
const
dataset.hpp:734
ot::MeshCoP::Dataset::Info
ot::MeshCoP::Dataset::Info::Get() const
return
static_cast
<
const
Ip6
::
NetworkPrefix
&
>
(
mMeshLocalPrefix
)
;
dataset.hpp:736
ot::MeshCoP::Dataset::Info::Get() const
Ip6
::
NetworkPrefix
meshLocalPrefix
;
dataset_manager_ftd.cpp:58
ot::MeshCoP::DatasetManager::ProcessSetOrReplaceRequest() const
void
Set
(
const
Ip6
::
Prefix
&
aPrefix
,
const
Ip6
::
NetworkPrefix
&
aMeshLocalPrefix
,
uint8_t
aContextId
)
dhcp6_server.hpp:152
ot::Dhcp6::Server::PrefixAgent::Set()
ot::Dhcp6::Server::PrefixAgent::Set()::aMeshLocalPrefix
Error
NetworkPrefix
::
GenerateRandomUla
(
void
)
ip6_address.cpp:44
ot::Ip6::NetworkPrefix::GenerateRandomUla()
bool
Prefix
::
ContainsPrefix
(
const
NetworkPrefix
&
aSubPrefix
)
const
ip6_address.cpp:81
ot::Ip6::Prefix::ContainsPrefix() const
ot::Ip6::Prefix::ContainsPrefix() const::aSubPrefix
return
(
mLength
>=
NetworkPrefix
::
kLength
)
&&
ip6_address.cpp:83
ot::Ip6::Prefix::ContainsPrefix() const
(
MatchLength
(
GetBytes
(
)
,
aSubPrefix
.
m8
,
NetworkPrefix
::
kSize
)
>=
NetworkPrefix
::
kLength
)
;
ip6_address.cpp:84
ot::Ip6::Prefix::ContainsPrefix() const
if
(
aPrefix
.
GetLength
(
)
>
NetworkPrefix
::
kLength
)
ip6_address.cpp:305
ot::Ip6::InterfaceIdentifier::ApplyPrefix()
Address
::
CopyBits
(
mFields
.
m8
,
aPrefix
.
GetBytes
(
)
+
NetworkPrefix
::
kSize
,
ip6_address.cpp:307
ot::Ip6::InterfaceIdentifier::ApplyPrefix()
aPrefix
.
GetLength
(
)
-
NetworkPrefix
::
kLength
)
;
ip6_address.cpp:308
ot::Ip6::InterfaceIdentifier::ApplyPrefix()
void
Address
::
SetPrefix
(
const
NetworkPrefix
&
aNetworkPrefix
)
{
mFields
.
mComponents
.
mNetworkPrefix
=
aNetworkPrefix
;
}
ip6_address.cpp:404
ot::Ip6::Address::SetPrefix()
ot::Ip6::Address::SetPrefix()::aNetworkPrefix
void
Address
::
SetToLocator
(
const
NetworkPrefix
&
aNetworkPrefix
,
uint16_t
aLocator
)
ip6_address.cpp:438
ot::Ip6::Address::SetToLocator()
ot::Ip6::Address::SetToLocator()::aNetworkPrefix
void
Set
(
const
NetworkPrefix
&
aNetworkPrefix
)
{
Set
(
aNetworkPrefix
.
m8
,
NetworkPrefix
::
kLength
)
;
}
ip6_address.hpp:144
ot::Ip6::Prefix::Set()
ot::Ip6::Prefix::Set()::aNetworkPrefix
bool
ContainsPrefix
(
const
NetworkPrefix
&
aSubPrefix
)
const
;
ip6_address.hpp:226
ot::Ip6::Prefix::ContainsPrefix() const
ot::Ip6::Prefix::ContainsPrefix() const::aSubPrefix
void
SetToRoutingLocator
(
const
NetworkPrefix
&
aNetworkPrefix
,
uint16_t
aRloc16
)
ip6_address.hpp:725
ot::Ip6::Address::SetToRoutingLocator()
ot::Ip6::Address::SetToRoutingLocator()::aNetworkPrefix
void
SetToAnycastLocator
(
const
NetworkPrefix
&
aNetworkPrefix
,
uint16_t
aAloc16
)
ip6_address.hpp:737
ot::Ip6::Address::SetToAnycastLocator()
ot::Ip6::Address::SetToAnycastLocator()::aNetworkPrefix
const
NetworkPrefix
&
GetPrefix
(
void
)
const
ip6_address.hpp:766
ot::Ip6::Address
ot::Ip6::Address::GetPrefix() const
return
static_cast
<
const
NetworkPrefix
&
>
(
mFields
.
mComponents
.
mNetworkPrefix
)
;
ip6_address.hpp:768
ot::Ip6::Address::GetPrefix() const
void
SetPrefix
(
const
NetworkPrefix
&
aNetworkPrefix
)
;
ip6_address.hpp:816
ot::Ip6::Address::SetPrefix()
ot::Ip6::Address::SetPrefix()::aNetworkPrefix
void
SetMulticastNetworkPrefix
(
const
NetworkPrefix
&
aNetworkPrefix
)
ip6_address.hpp:841
ot::Ip6::Address::SetMulticastNetworkPrefix()
ot::Ip6::Address::SetMulticastNetworkPrefix()::aNetworkPrefix
SetMulticastNetworkPrefix
(
aNetworkPrefix
.
m8
,
NetworkPrefix
::
kLength
)
;
ip6_address.hpp:843
ot::Ip6::Address::SetMulticastNetworkPrefix()
void
SetToLocator
(
const
NetworkPrefix
&
aNetworkPrefix
,
uint16_t
aLocator
)
;
ip6_address.hpp:964
ot::Ip6::Address::SetToLocator()
ot::Ip6::Address::SetToLocator()::aNetworkPrefix
DefineCoreType
(
otIp6NetworkPrefix
,
Ip6
::
NetworkPrefix
)
;
ip6_address.hpp:986
ot::CoreType::Type
typedef
SimpleTlvInfo
<
Tlv
::
kMeshLocalPrefix
,
Ip6
::
NetworkPrefix
>
MeshLocalPrefixTlv
;
meshcop_tlvs.hpp:312
void
Mle
::
SetMeshLocalPrefix
(
const
Ip6
::
NetworkPrefix
&
aMeshLocalPrefix
)
mle.cpp:874
ot::Mle::Mle::SetMeshLocalPrefix()
ot::Mle::Mle::SetMeshLocalPrefix()::aMeshLocalPrefix
const
Ip6
::
NetworkPrefix
&
GetMeshLocalPrefix
(
void
)
const
{
return
mMeshLocalPrefix
;
}
mle.hpp:333
ot::Mle::Mle
ot::Mle::Mle::GetMeshLocalPrefix() const
void
SetMeshLocalPrefix
(
const
Ip6
::
NetworkPrefix
&
aMeshLocalPrefix
)
;
mle.hpp:340
ot::Mle::Mle::SetMeshLocalPrefix()
ot::Mle::Mle::SetMeshLocalPrefix()::aMeshLocalPrefix
Ip6
::
NetworkPrefix
mMeshLocalPrefix
;
mle.hpp:1401
ot::Mle::Mle
ot::Mle::Mle::mMeshLocalPrefix
mPrefixLength
=
NetworkPrefix
::
kLength
;
netif.cpp:544
ot::Ip6::Netif::UnicastAddress::InitAsThreadOrigin()
VerifyOrExit
(
GetPrefix
(
)
.
GetLength
(
)
==
Ip6
::
NetworkPrefix
::
kLength
)
;
network_data_types.cpp:67
ot::NetworkData::OnMeshPrefixConfig::IsValid() const
Ip6
::
NetworkPrefix
randomUlaPrefix
;
routing_manager.cpp:256
ot::BorderRouter::RoutingManager::LoadOrGenerateRandomBrUlaPrefix()
return
aConfig
.
mSlaac
&&
!
aConfig
.
mDp
&&
(
aConfig
.
GetPrefix
(
)
.
GetLength
(
)
==
Ip6
::
NetworkPrefix
::
kLength
)
;
slaac_address.cpp:121
ot::Utils::Slaac::IsSlaac() const
Call Tree
from
examples
All items filtered out
All items filtered out
Data Use
from
examples
All items filtered out
All items filtered out
Class Tree
from
examples
ot::Ip6::NetworkPrefix
is inherited by 1 classes:
All items filtered out
ot::Ip6::NetworkPrefix
otIp6NetworkPrefix
All items filtered out
Override Tree
from
examples
All items filtered out
All items filtered out
Implementations
from
examples
All items filtered out
All items filtered out
Instances
from
examples
Instance
Scope
Location
Project
ot::Ip6::Prefix::Set()::aNetworkPrefix
ot::Ip6::Prefix::Set()
ip6_address.hpp:144
ot::Ip6::Prefix::ContainsPrefix() const::aSubPrefix
ot::Ip6::Prefix::ContainsPrefix() const
ip6_address.hpp:226
ot::Ip6::Address::SetToRoutingLocator()::aNetworkPrefix
ot::Ip6::Address::SetToRoutingLocator()
ip6_address.hpp:725
ot::Ip6::Address::SetToAnycastLocator()::aNetworkPrefix
ot::Ip6::Address::SetToAnycastLocator()
ip6_address.hpp:737
return
ot::Ip6::Address::GetPrefix() const
ip6_address.hpp:766
ot::Ip6::Address::SetPrefix()::aNetworkPrefix
ot::Ip6::Address::SetPrefix()
ip6_address.hpp:816
ot::Ip6::Address::SetMulticastNetworkPrefix()::aNetworkPrefix
ot::Ip6::Address::SetMulticastNetworkPrefix()
ip6_address.hpp:841
ot::Ip6::Address::SetToLocator()::aNetworkPrefix
ot::Ip6::Address::SetToLocator()
ip6_address.hpp:964
ot::CoreType::Type
ip6_address.hpp:986
ot::MeshCoP::Dataset::TypeFor::Type
dataset.hpp:705
return
ot::MeshCoP::Dataset::Info::Get() const
dataset.hpp:734
return
ot::Mle::Mle::GetMeshLocalPrefix() const
mle.hpp:333
ot::Mle::Mle::SetMeshLocalPrefix()::aMeshLocalPrefix
ot::Mle::Mle::SetMeshLocalPrefix()
mle.hpp:340
ot::Mle::Mle::mMeshLocalPrefix
ot::Mle::Mle
mle.hpp:1401
ot::Dhcp6::Server::PrefixAgent::Set()::aMeshLocalPrefix
ot::Dhcp6::Server::PrefixAgent::Set()
dhcp6_server.hpp:152
ot::Mle::Mle::SetMeshLocalPrefix()::aMeshLocalPrefix
ot::Mle::Mle::SetMeshLocalPrefix()
mle.cpp:874
ot::Ip6::Prefix::ContainsPrefix() const::aSubPrefix
ot::Ip6::Prefix::ContainsPrefix() const
ip6_address.cpp:81
ot::Ip6::Address::SetPrefix()::aNetworkPrefix
ot::Ip6::Address::SetPrefix()
ip6_address.cpp:404
ot::Ip6::Address::SetToLocator()::aNetworkPrefix
ot::Ip6::Address::SetToLocator()
ip6_address.cpp:438
Lifecycle
from
examples
All items filtered out
All items filtered out