ESP-IDF
ot::Settings::ChildInfoIteratorBuilder
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading...
Files
loading...
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::Settings::ChildInfoIteratorBuilder
ot::Settings::ChildInfoIteratorBuilder class
Syntax
Show:
Summary
Declaration
Definition
from
settings.hpp:747
class
ChildInfoIteratorBuilder
;
public
:
explicit
Settings
(
Instance
&
aInstance
)
:
SettingsBase
(
aInstance
)
{
}
void
Init
(
void
)
;
void
Deinit
(
void
)
;
void
Wipe
(
void
)
;
void
SaveOperationalDataset
(
MeshCoP
::
Dataset
::
Type
aType
,
const
MeshCoP
::
Dataset
&
aDataset
)
;
Error
ReadOperationalDataset
(
MeshCoP
::
Dataset
::
Type
aType
,
MeshCoP
::
Dataset
&
aDataset
)
const
;
void
DeleteOperationalDataset
(
MeshCoP
::
Dataset
::
Type
aType
)
;
template
<
typename
EntryType
>
Error
Read
(
EntryType
&
aEntry
)
const
{
aEntry
.
Init
(
)
;
return
ReadEntry
(
EntryType
::
kKey
,
&
aEntry
,
sizeof
(
EntryType
)
)
;
}
template
<
typename
EntryType
>
Error
Read
(
typename
EntryType
::
ValueType
&
aValue
)
const
{
return
ReadEntry
(
EntryType
::
kKey
,
&
aValue
,
sizeof
(
typename
EntryType
::
ValueType
)
)
;
}
template
<
typename
EntryType
>
Error
Save
(
const
EntryType
&
aEntry
)
{
EntryType
prev
;
return
SaveEntry
(
EntryType
::
kKey
,
&
aEntry
,
&
prev
,
sizeof
(
EntryType
)
)
;
}
template
<
typename
EntryType
>
Error
Save
(
const
typename
EntryType
::
ValueType
&
aValue
)
{
typename
EntryType
::
ValueType
prev
;
return
SaveEntry
(
EntryType
::
kKey
,
&
aValue
,
&
prev
,
sizeof
(
typename
EntryType
::
ValueType
)
)
;
}
template
<
typename
EntryType
>
Error
Delete
(
void
)
{
return
DeleteEntry
(
EntryType
::
kKey
)
;
}
#if
OPENTHREAD_FTD
Error
AddChildInfo
(
const
ChildInfo
&
aChildInfo
)
;
Error
DeleteAllChildInfo
(
void
)
;
ChildInfoIteratorBuilder
IterateChildInfo
(
void
)
{
return
ChildInfoIteratorBuilder
(
GetInstance
(
)
)
;
}
class
ChildInfoIterator
:
public
SettingsBase
,
public
Unequatable
<
ChildInfoIterator
>
{
friend
class
ChildInfoIteratorBuilder
;
public
:
explicit
ChildInfoIterator
(
Instance
&
aInstance
)
;
bool
IsDone
(
void
)
const
{
return
mIsDone
;
}
void
operator
++
(
void
)
{
Advance
(
)
;
}
void
operator
++
(
int
)
{
Advance
(
)
;
}
const
ChildInfo
&
GetChildInfo
(
void
)
const
{
return
mChildInfo
;
}
Error
Delete
(
void
)
;
const
ChildInfo
&
operator
*
(
void
)
const
{
return
mChildInfo
;
}
bool
operator
==
(
const
ChildInfoIterator
&
aOther
)
const
{
return
(
mIsDone
&&
aOther
.
mIsDone
)
||
(
!
mIsDone
&&
!
aOther
.
mIsDone
&&
(
mIndex
==
aOther
.
mIndex
)
)
;
}
private
:
enum
IteratorType
:
uint8_t
{
kEndIterator
,
}
;
ChildInfoIterator
(
Instance
&
aInstance
,
IteratorType
)
:
SettingsBase
(
aInstance
)
,
mIndex
(
0
)
,
mIsDone
(
true
)
{
}
void
Advance
(
void
)
;
void
Read
(
void
)
;
ChildInfo
mChildInfo
;
uint16_t
mIndex
;
bool
mIsDone
;
}
;
#endif
#if
OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
Error
AddOrUpdateBrOnLinkPrefix
(
const
BrOnLinkPrefix
&
aBrOnLinkPrefix
)
;
Error
RemoveBrOnLinkPrefix
(
const
Ip6
::
Prefix
&
aPrefix
)
;
Error
DeleteAllBrOnLinkPrefixes
(
void
)
;
Error
ReadBrOnLinkPrefix
(
int
aIndex
,
BrOnLinkPrefix
&
aBrOnLinkPrefix
)
;
#endif
private
:
#if
OPENTHREAD_FTD
class
ChildInfoIteratorBuilder
:
public
InstanceLocator
;
Implemented in
settings.hpp:1103
Methods
begin()
end()
Examples
References
from
examples
Code
Location
Scope
Referrer
class
ChildInfoIteratorBuilder
:
public
InstanceLocator
settings.hpp:1103
class
ChildInfoIteratorBuilder
;
settings.hpp:747
ChildInfoIteratorBuilder
IterateChildInfo
(
void
)
{
return
ChildInfoIteratorBuilder
(
GetInstance
(
)
)
;
}
settings.hpp:951
ot::Settings
ot::Settings::IterateChildInfo()
friend
class
ChildInfoIteratorBuilder
;
settings.hpp:958
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::Settings::ChildInfoIteratorBuilder
is inherited by 1 classes:
All items filtered out
ot::Settings::ChildInfoIteratorBuilder
ot::InstanceLocator
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::Settings::IterateChildInfo()
settings.hpp:951
Lifecycle
from
examples
All items filtered out
All items filtered out