ESP-IDF
ot::NetworkData::Publisher::Entry
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading...
Files
loading...
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::NetworkData::Publisher::Entry
ot::NetworkData::Publisher::Entry class
Syntax
Show:
Summary
Declaration
from
network_data_publisher.hpp:311
class
Entry
:
public
InstanceLocatorInit
{
protected
:
enum
State
:
uint8_t
{
kNoEntry
,
kToAdd
,
kAdding
,
kAdded
,
kRemoving
,
}
;
static
constexpr
uint32_t
kMaxDelayToAdd
=
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_ADD
;
static
constexpr
uint32_t
kMaxDelayToRemove
=
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE
;
static
constexpr
uint32_t
kExtraDelayToRemovePreferred
=
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED
;
static
constexpr
uint16_t
kInfoStringSize
=
60
;
typedef
String
<
kInfoStringSize
>
InfoString
;
Entry
(
void
)
:
mState
(
kNoEntry
)
{
}
void
Init
(
Instance
&
aInstance
)
{
InstanceLocatorInit
::
Init
(
aInstance
)
;
}
State
GetState
(
void
)
const
{
return
mState
;
}
void
SetState
(
State
aState
)
;
const
TimeMilli
&
GetUpdateTime
(
void
)
const
{
return
mUpdateTime
;
}
bool
IsPreferred
(
uint16_t
aRloc16
)
const
;
void
UpdateState
(
uint8_t
aNumEntries
,
uint8_t
aNumPreferredEntries
,
uint8_t
aDesiredNumEntries
)
;
void
HandleTimer
(
void
)
;
InfoString
ToString
(
bool
aIncludeState
=
true
)
const
;
public
:
bool
IsAdded
(
void
)
const
{
return
(
mState
==
kAdded
)
;
}
private
:
void
Add
(
void
)
;
void
Remove
(
State
aNextState
)
;
void
LogUpdateTime
(
void
)
const
;
static
const
char
*
StateToString
(
State
aState
)
;
TimeMilli
mUpdateTime
;
State
mState
;
}
;
Fields
Field
Declared as
ot::NetworkData::Publisher::Entry::kMaxDelayToAdd
ot::NetworkData::Publisher::Entry::kMaxDelayToRemove
ot::NetworkData::Publisher::Entry::kExtraDelayToRemovePreferred
ot::NetworkData::Publisher::Entry::kInfoStringSize
ot::NetworkData::Publisher::Entry::mUpdateTime
TimeMilli
ot::NetworkData::Publisher::Entry::mState
State
Methods
Init()
GetState() const
SetState()
GetUpdateTime() const
IsPreferred() const
UpdateState()
HandleTimer()
ToString() const
IsAdded() const
Add()
Remove()
LogUpdateTime() const
StateToString()
Related Functions
Found 2 other functions taking a
Entry
argument:
Function
ot::NetworkData::Publisher::IsAPrefixEntry() const
ot::NetworkData::Publisher::IsADnsSrpServiceEntry() const
Examples
References
from
examples
Code
Location
Scope
Referrer
class
Entry
:
public
InstanceLocatorInit
network_data_publisher.hpp:311
bool
Publisher
::
IsAPrefixEntry
(
const
Entry
&
aEntry
)
const
network_data_publisher.cpp:207
ot::NetworkData::Publisher::IsAPrefixEntry() const
ot::NetworkData::Publisher::IsAPrefixEntry() const::aEntry
void
Publisher
::
Entry
::
SetState
(
State
aState
)
network_data_publisher.cpp:250
ot::NetworkData::Publisher::Entry::SetState()
bool
Publisher
::
Entry
::
IsPreferred
(
uint16_t
aRloc16
)
const
network_data_publisher.cpp:262
ot::NetworkData::Publisher::Entry::IsPreferred() const
void
Publisher
::
Entry
::
UpdateState
(
uint8_t
aNumEntries
,
uint8_t
aNumPreferredEntries
,
uint8_t
aDesiredNumEntries
)
network_data_publisher.cpp:275
ot::NetworkData::Publisher::Entry::UpdateState()
void
Publisher
::
Entry
::
HandleTimer
(
void
)
network_data_publisher.cpp:353
ot::NetworkData::Publisher::Entry::HandleTimer()
void
Publisher
::
Entry
::
Add
(
void
)
network_data_publisher.cpp:382
ot::NetworkData::Publisher::Entry::Add()
void
Publisher
::
Entry
::
Remove
(
State
aNextState
)
network_data_publisher.cpp:399
ot::NetworkData::Publisher::Entry::Remove()
Publisher
::
Entry
::
InfoString
Publisher
::
Entry
::
ToString
(
bool
aIncludeState
)
const
network_data_publisher.cpp:416
ot::NetworkData::Publisher::Entry::ToString() const
void
Publisher
::
Entry
::
LogUpdateTime
(
void
)
const
network_data_publisher.cpp:458
ot::NetworkData::Publisher::Entry::LogUpdateTime() const
const
char
*
Publisher
::
Entry
::
StateToString
(
State
aState
)
network_data_publisher.cpp:463
ot::NetworkData::Publisher::Entry::StateToString()
class
DnsSrpServiceEntry
:
public
Entry
,
private
NonCopyable
network_data_publisher.hpp:361
ot::NetworkData::Publisher
ot::NetworkData::Publisher::DnsSrpServiceEntry
friend
class
Entry
;
network_data_publisher.hpp:363
void
HandleTimer
(
void
)
{
Entry
::
HandleTimer
(
)
;
}
network_data_publisher.hpp:372
ot::NetworkData::Publisher::DnsSrpServiceEntry::HandleTimer()
class
PrefixEntry
:
public
Entry
,
private
NonCopyable
network_data_publisher.hpp:442
ot::NetworkData::Publisher
ot::NetworkData::Publisher::PrefixEntry
friend
class
Entry
;
network_data_publisher.hpp:444
void
Init
(
Instance
&
aInstance
)
{
Entry
::
Init
(
aInstance
)
;
}
network_data_publisher.hpp:447
ot::NetworkData::Publisher::PrefixEntry::Init()
void
HandleTimer
(
void
)
{
Entry
::
HandleTimer
(
)
;
}
network_data_publisher.hpp:454
ot::NetworkData::Publisher::PrefixEntry::HandleTimer()
bool
IsADnsSrpServiceEntry
(
const
Entry
&
aEntry
)
const
{
return
(
&
aEntry
==
&
mDnsSrpServiceEntry
)
;
}
network_data_publisher.hpp:487
ot::NetworkData::Publisher::IsADnsSrpServiceEntry() const
ot::NetworkData::Publisher::IsADnsSrpServiceEntry() const::aEntry
bool
IsAPrefixEntry
(
const
Entry
&
aEntry
)
const
;
network_data_publisher.hpp:494
ot::NetworkData::Publisher::IsAPrefixEntry() const
ot::NetworkData::Publisher::IsAPrefixEntry() const::aEntry
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::Entry
inherits 2 classess and is inherited by 1 classes:
ot::NetworkData::Publisher::DnsSrpServiceEntry
ot::NetworkData::Publisher::PrefixEntry
All items filtered out
ot::NetworkData::Publisher::Entry
ot::InstanceLocatorInit
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::NetworkData::Publisher::IsADnsSrpServiceEntry() const::aEntry
ot::NetworkData::Publisher::IsADnsSrpServiceEntry() const
network_data_publisher.hpp:487
ot::NetworkData::Publisher::IsAPrefixEntry() const::aEntry
ot::NetworkData::Publisher::IsAPrefixEntry() const
network_data_publisher.hpp:494
ot::NetworkData::Publisher::IsAPrefixEntry() const::aEntry
ot::NetworkData::Publisher::IsAPrefixEntry() const
network_data_publisher.cpp:207
Lifecycle
from
examples
All items filtered out
All items filtered out