ESP-IDF
ot::NetworkData::Publisher::PrefixEntry
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading...
Files
loading (1/5)...
Summary
Syntax
Methods
Examples
References
Call Tree
Data Use
Class Tree
Override Tree
Implementations
Instances
Lifecycle
SourceVu
ESP-IDF Framework and Examples
ESP-IDF
ot::NetworkData::Publisher::PrefixEntry
ot::NetworkData::Publisher::PrefixEntry class
Syntax
Show:
Summary
Declaration
from
network_data_publisher.hpp:442
class
PrefixEntry
:
public
Entry
,
private
NonCopyable
{
friend
class
Entry
;
public
:
void
Init
(
Instance
&
aInstance
)
{
Entry
::
Init
(
aInstance
)
;
}
bool
IsInUse
(
void
)
const
{
return
GetState
(
)
!=
kNoEntry
;
}
bool
Matches
(
const
Ip6
::
Prefix
&
aPrefix
)
const
{
return
mPrefix
==
aPrefix
;
}
void
Publish
(
const
OnMeshPrefixConfig
&
aConfig
,
Requester
aRequester
)
;
void
Publish
(
const
ExternalRouteConfig
&
aConfig
,
Requester
aRequester
)
;
Requester
GetRequester
(
void
)
const
{
return
mRequester
;
}
void
Unpublish
(
void
)
;
void
HandleTimer
(
void
)
{
Entry
::
HandleTimer
(
)
;
}
void
HandleNotifierEvents
(
Events
aEvents
)
;
private
:
static
constexpr
uint8_t
kDesiredNumOnMeshPrefix
=
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ON_MESH_PREFIX_ENTRIES
;
static
constexpr
uint8_t
kDesiredNumExternalRoute
=
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_EXTERNAL_ROUTE_ENTRIES
;
enum
Type
:
uint8_t
{
kTypeOnMeshPrefix
,
kTypeExternalRoute
,
}
;
void
Publish
(
const
Ip6
::
Prefix
&
aPrefix
,
uint16_t
aNewFlags
,
Type
aNewType
,
Requester
aRequester
)
;
void
Add
(
void
)
;
Error
AddOnMeshPrefix
(
void
)
;
Error
AddExternalRoute
(
void
)
;
void
Remove
(
State
aNextState
)
;
void
Process
(
void
)
;
void
CountOnMeshPrefixEntries
(
uint8_t
&
aNumEntries
,
uint8_t
&
aNumPreferredEntries
)
const
;
void
CountExternalRouteEntries
(
uint8_t
&
aNumEntries
,
uint8_t
&
aNumPreferredEntries
)
const
;
Type
mType
;
Requester
mRequester
;
Ip6
::
Prefix
mPrefix
;
uint16_t
mFlags
;
}
;
Fields
Field
Declared as
ot::NetworkData::Publisher::PrefixEntry::kDesiredNumOnMeshPrefix
ot::NetworkData::Publisher::PrefixEntry::kDesiredNumExternalRoute
ot::NetworkData::Publisher::PrefixEntry::mType
Type
ot::NetworkData::Publisher::PrefixEntry::mRequester
Requester
ot::NetworkData::Publisher::PrefixEntry::mPrefix
Ip6
::
Prefix
ot::NetworkData::Publisher::PrefixEntry::mFlags
uint16_t
Methods
Init()
IsInUse() const
Matches() const
Publish()
Publish()
GetRequester() const
Unpublish()
HandleTimer()
HandleNotifierEvents()
Publish()
Add()
AddOnMeshPrefix()
AddExternalRoute()
Remove()
Process()
CountOnMeshPrefixEntries() const
CountExternalRouteEntries() const
Examples
References
from
examples
Code
Location
Scope
Referrer
class
PrefixEntry
:
public
Entry
,
private
NonCopyable
network_data_publisher.hpp:442
PrefixEntry
*
entry
;
network_data_publisher.cpp:74
ot::NetworkData::Publisher::PublishOnMeshPrefix()
PrefixEntry
*
entry
;
network_data_publisher.cpp:98
ot::NetworkData::Publisher::ReplacePublishedExternalRoute()
const
PrefixEntry
*
entry
;
network_data_publisher.cpp:115
ot::NetworkData::Publisher::IsPrefixAdded() const
PrefixEntry
*
entry
;
network_data_publisher.cpp:129
ot::NetworkData::Publisher::UnpublishPrefix()
Publisher
::
PrefixEntry
*
Publisher
::
FindOrAllocatePrefixEntry
(
const
Ip6
::
Prefix
&
aPrefix
,
Requester
aRequester
)
network_data_publisher.cpp:140
ot::NetworkData::Publisher
ot::NetworkData::Publisher::FindOrAllocatePrefixEntry()
PrefixEntry
*
prefixEntry
=
nullptr
;
network_data_publisher.cpp:145
ot::NetworkData::Publisher::FindOrAllocatePrefixEntry()
Publisher
::
PrefixEntry
*
Publisher
::
FindMatchingPrefixEntry
(
const
Ip6
::
Prefix
&
aPrefix
)
network_data_publisher.cpp:186
ot::NetworkData::Publisher
ot::NetworkData::Publisher::FindMatchingPrefixEntry()
const
Publisher
::
PrefixEntry
*
Publisher
::
FindMatchingPrefixEntry
(
const
Ip6
::
Prefix
&
aPrefix
)
const
network_data_publisher.cpp:191
ot::NetworkData::Publisher
ot::NetworkData::Publisher::FindMatchingPrefixEntry() const
const
PrefixEntry
*
prefixEntry
=
nullptr
;
network_data_publisher.cpp:193
ot::NetworkData::Publisher::FindMatchingPrefixEntry() const
static_cast
<
PrefixEntry
*
>
(
this
)
->
Add
(
)
;
network_data_publisher.cpp:394
ot::NetworkData::Publisher::Entry::Add()
static_cast
<
PrefixEntry
*
>
(
this
)
->
Remove
(
aNextState
)
;
network_data_publisher.cpp:411
ot::NetworkData::Publisher::Entry::Remove()
const
PrefixEntry
&
prefixEntry
=
*
static_cast
<
const
PrefixEntry
*
>
(
this
)
;
network_data_publisher.cpp:431
ot::NetworkData::Publisher::Entry::ToString() const
case
PrefixEntry
::
kTypeOnMeshPrefix
:
network_data_publisher.cpp:435
ot::NetworkData::Publisher::Entry::ToString() const
case
PrefixEntry
::
kTypeExternalRoute
:
network_data_publisher.cpp:439
ot::NetworkData::Publisher::Entry::ToString() const
void
Publisher
::
PrefixEntry
::
Publish
(
const
OnMeshPrefixConfig
&
aConfig
,
Requester
aRequester
)
network_data_publisher.cpp:771
ot::NetworkData::Publisher::PrefixEntry::Publish()
void
Publisher
::
PrefixEntry
::
Publish
(
const
ExternalRouteConfig
&
aConfig
,
Requester
aRequester
)
network_data_publisher.cpp:778
ot::NetworkData::Publisher::PrefixEntry::Publish()
void
Publisher
::
PrefixEntry
::
Publish
(
const
Ip6
::
Prefix
&
aPrefix
,
network_data_publisher.cpp:785
ot::NetworkData::Publisher::PrefixEntry::Publish()
void
Publisher
::
PrefixEntry
::
Unpublish
(
void
)
network_data_publisher.cpp:828
ot::NetworkData::Publisher::PrefixEntry::Unpublish()
void
Publisher
::
PrefixEntry
::
HandleNotifierEvents
(
Events
aEvents
)
network_data_publisher.cpp:835
ot::NetworkData::Publisher::PrefixEntry::HandleNotifierEvents()
void
Publisher
::
PrefixEntry
::
Add
(
void
)
network_data_publisher.cpp:843
ot::NetworkData::Publisher::PrefixEntry::Add()
Error
Publisher
::
PrefixEntry
::
AddOnMeshPrefix
(
void
)
network_data_publisher.cpp:866
ot::NetworkData::Publisher::PrefixEntry::AddOnMeshPrefix()
Error
Publisher
::
PrefixEntry
::
AddExternalRoute
(
void
)
network_data_publisher.cpp:877
ot::NetworkData::Publisher::PrefixEntry::AddExternalRoute()
void
Publisher
::
PrefixEntry
::
Remove
(
State
aNextState
)
network_data_publisher.cpp:888
ot::NetworkData::Publisher::PrefixEntry::Remove()
void
Publisher
::
PrefixEntry
::
Process
(
void
)
network_data_publisher.cpp:912
ot::NetworkData::Publisher::PrefixEntry::Process()
void
Publisher
::
PrefixEntry
::
CountOnMeshPrefixEntries
(
uint8_t
&
aNumEntries
,
uint8_t
&
aNumPreferredEntries
)
const
network_data_publisher.cpp:946
ot::NetworkData::Publisher::PrefixEntry::CountOnMeshPrefixEntries() const
void
Publisher
::
PrefixEntry
::
CountExternalRouteEntries
(
uint8_t
&
aNumEntries
,
uint8_t
&
aNumPreferredEntries
)
const
network_data_publisher.cpp:993
ot::NetworkData::Publisher::PrefixEntry::CountExternalRouteEntries() const
PrefixEntry
*
FindOrAllocatePrefixEntry
(
const
Ip6
::
Prefix
&
aPrefix
,
Requester
aRequester
)
;
network_data_publisher.hpp:491
ot::NetworkData::Publisher
ot::NetworkData::Publisher::FindOrAllocatePrefixEntry()
PrefixEntry
*
FindMatchingPrefixEntry
(
const
Ip6
::
Prefix
&
aPrefix
)
;
network_data_publisher.hpp:492
ot::NetworkData::Publisher
ot::NetworkData::Publisher::FindMatchingPrefixEntry()
const
PrefixEntry
*
FindMatchingPrefixEntry
(
const
Ip6
::
Prefix
&
aPrefix
)
const
;
network_data_publisher.hpp:493
ot::NetworkData::Publisher
ot::NetworkData::Publisher::FindMatchingPrefixEntry() const
PrefixEntry
mPrefixEntries
[
kMaxUserPrefixEntries
+
kMaxRoutingManagerPrefixEntries
]
;
network_data_publisher.hpp:509
ot::NetworkData::Publisher
ot::NetworkData::Publisher::mPrefixEntries
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::NetworkData::Publisher::PrefixEntry
is inherited by 2 classess:
All items filtered out
ot::NetworkData::Publisher::PrefixEntry
ot::NonCopyable
ot::NetworkData::Publisher::Entry
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
return
ot::NetworkData::Publisher::FindOrAllocatePrefixEntry()
network_data_publisher.hpp:491
return
ot::NetworkData::Publisher::FindMatchingPrefixEntry()
network_data_publisher.hpp:492
return
ot::NetworkData::Publisher::FindMatchingPrefixEntry() const
network_data_publisher.hpp:493
ot::NetworkData::Publisher::mPrefixEntries
ot::NetworkData::Publisher
network_data_publisher.hpp:509
return
ot::NetworkData::Publisher::FindOrAllocatePrefixEntry()
network_data_publisher.cpp:140
return
ot::NetworkData::Publisher::FindMatchingPrefixEntry()
network_data_publisher.cpp:186
return
ot::NetworkData::Publisher::FindMatchingPrefixEntry() const
network_data_publisher.cpp:191
Lifecycle
from
examples
All items filtered out
All items filtered out