ESP-IDF
ot::SettingsBase::BrOnLinkPrefix
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading (2/5)...
Files
loading (3/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::SettingsBase::BrOnLinkPrefix
ot::SettingsBase::BrOnLinkPrefix class
Syntax
Show:
Summary
Declaration
from
settings.hpp:546
class
BrOnLinkPrefix
:
public
Clearable
<
BrOnLinkPrefix
>
{
friend
class
Settings
;
public
:
static
constexpr
Key
kKey
=
kKeyBrOnLinkPrefixes
;
void
Init
(
void
)
{
Clear
(
)
;
}
const
Ip6
::
Prefix
&
GetPrefix
(
void
)
const
{
return
mPrefix
;
}
void
SetPrefix
(
const
Ip6
::
Prefix
&
aPrefix
)
{
mPrefix
=
aPrefix
;
}
uint32_t
GetLifetime
(
void
)
const
{
return
mLifetime
;
}
void
SetLifetime
(
uint32_t
aLifetime
)
{
mLifetime
=
aLifetime
;
}
private
:
void
Log
(
const
char
*
aActionText
)
const
;
Ip6
::
Prefix
mPrefix
;
uint32_t
mLifetime
;
}
;
Fields
Field
Declared as
ot::SettingsBase::BrOnLinkPrefix::kKey
ot::SettingsBase::BrOnLinkPrefix::mPrefix
Ip6
::
Prefix
ot::SettingsBase::BrOnLinkPrefix::mLifetime
uint32_t
Methods
Init()
Initializes the `BrOnLinkPrefix` object.
GetPrefix() const
Gets the prefix.
SetPrefix()
Set the prefix.
GetLifetime() const
Gets the remaining prefix lifetime in seconds.
SetLifetime()
Sets the the prefix lifetime.
Log() const
Related Functions
Found 2 other functions taking a
BrOnLinkPrefix
argument:
Function
Description
ot::Settings::ReadBrOnLinkPrefix()
Retrieves an entry from on-link prefixes list at a given index.
ot::Settings::AddOrUpdateBrOnLinkPrefix()
Adds or updates an on-link prefix. If there is no matching entry (matching the same `GetPrefix()`) saved in `Settings`, the new entry will be added. If there is matching entry, it will be updated to the new @p aPrefix.
Examples
References
from
examples
Code
Location
Scope
Referrer
class
BrOnLinkPrefix
:
public
Clearable
<
BrOnLinkPrefix
>
settings.hpp:546
Settings
::
BrOnLinkPrefix
savedPrefix
;
routing_manager.cpp:2514
ot::BorderRouter::RoutingManager::OnLinkPrefixManager::Init()
Settings
::
BrOnLinkPrefix
savedPrefix
;
routing_manager.cpp:2952
ot::BorderRouter::RoutingManager::OnLinkPrefixManager::SavePrefix()
Error
Settings
::
AddOrUpdateBrOnLinkPrefix
(
const
BrOnLinkPrefix
&
aBrOnLinkPrefix
)
settings.cpp:330
ot::Settings::AddOrUpdateBrOnLinkPrefix()
ot::Settings::AddOrUpdateBrOnLinkPrefix()::aBrOnLinkPrefix
BrOnLinkPrefix
brPrefix
;
settings.cpp:334
ot::Settings::AddOrUpdateBrOnLinkPrefix()
SuccessOrExit
(
error
=
Get
<
SettingsDriver
>
(
)
.
Add
(
kKeyBrOnLinkPrefixes
,
&
aBrOnLinkPrefix
,
sizeof
(
BrOnLinkPrefix
)
)
)
;
settings.cpp:356
ot::Settings::AddOrUpdateBrOnLinkPrefix()
BrOnLinkPrefix
brPrefix
;
settings.cpp:366
ot::Settings::RemoveBrOnLinkPrefix()
Error
Settings
::
ReadBrOnLinkPrefix
(
int
aIndex
,
BrOnLinkPrefix
&
aBrOnLinkPrefix
)
settings.cpp:384
ot::Settings::ReadBrOnLinkPrefix()
ot::Settings::ReadBrOnLinkPrefix()::aBrOnLinkPrefix
uint16_t
length
=
sizeof
(
BrOnLinkPrefix
)
;
settings.cpp:386
ot::Settings::ReadBrOnLinkPrefix()
void
Settings
::
BrOnLinkPrefix
::
Log
(
const
char
*
aActionText
)
const
settings.cpp:393
ot::SettingsBase::BrOnLinkPrefix::Log() const
Error
AddOrUpdateBrOnLinkPrefix
(
const
BrOnLinkPrefix
&
aBrOnLinkPrefix
)
;
settings.hpp:1067
ot::Settings::AddOrUpdateBrOnLinkPrefix()
ot::Settings::AddOrUpdateBrOnLinkPrefix()::aBrOnLinkPrefix
Error
ReadBrOnLinkPrefix
(
int
aIndex
,
BrOnLinkPrefix
&
aBrOnLinkPrefix
)
;
settings.hpp:1097
ot::Settings::ReadBrOnLinkPrefix()
ot::Settings::ReadBrOnLinkPrefix()::aBrOnLinkPrefix
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
All items filtered out
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::Settings::AddOrUpdateBrOnLinkPrefix()::aBrOnLinkPrefix
ot::Settings::AddOrUpdateBrOnLinkPrefix()
settings.hpp:1067
ot::Settings::ReadBrOnLinkPrefix()::aBrOnLinkPrefix
ot::Settings::ReadBrOnLinkPrefix()
settings.hpp:1097
ot::Settings::AddOrUpdateBrOnLinkPrefix()::aBrOnLinkPrefix
ot::Settings::AddOrUpdateBrOnLinkPrefix()
settings.cpp:330
ot::Settings::ReadBrOnLinkPrefix()::aBrOnLinkPrefix
ot::Settings::ReadBrOnLinkPrefix()
settings.cpp:384
Lifecycle
from
examples
All items filtered out
All items filtered out