ESP-IDF
ot::Srp::Client::ItemState
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading...
Files
loading (2/5)...
Summary
Syntax
Values
Examples
References
Call Tree
Data Use
Class Tree
Override Tree
Implementations
Instances
Lifecycle
SourceVu
ESP-IDF Framework and Examples
ESP-IDF
ot::Srp::Client::ItemState
ot::Srp::Client::ItemState enum
Types represents an SRP client item (service or host info) state.
Syntax
Show:
Summary
Declaration
from
srp_client.hpp:85
enum
ItemState
:
uint8_t
{
kToAdd
=
OT_SRP_CLIENT_ITEM_STATE_TO_ADD
,
kAdding
=
OT_SRP_CLIENT_ITEM_STATE_ADDING
,
kToRefresh
=
OT_SRP_CLIENT_ITEM_STATE_TO_REFRESH
,
kRefreshing
=
OT_SRP_CLIENT_ITEM_STATE_REFRESHING
,
kToRemove
=
OT_SRP_CLIENT_ITEM_STATE_TO_REMOVE
,
kRemoving
=
OT_SRP_CLIENT_ITEM_STATE_REMOVING
,
kRegistered
=
OT_SRP_CLIENT_ITEM_STATE_REGISTERED
,
kRemoved
=
OT_SRP_CLIENT_ITEM_STATE_REMOVED
,
}
;
Values
Value
Declared as
ot::Srp::Client::ItemState::kToAdd
=
OT_SRP_CLIENT_ITEM_STATE_TO_ADD
ot::Srp::Client::ItemState::kAdding
=
OT_SRP_CLIENT_ITEM_STATE_ADDING
ot::Srp::Client::ItemState::kToRefresh
=
OT_SRP_CLIENT_ITEM_STATE_TO_REFRESH
ot::Srp::Client::ItemState::kRefreshing
=
OT_SRP_CLIENT_ITEM_STATE_REFRESHING
ot::Srp::Client::ItemState::kToRemove
=
OT_SRP_CLIENT_ITEM_STATE_TO_REMOVE
ot::Srp::Client::ItemState::kRemoving
=
OT_SRP_CLIENT_ITEM_STATE_REMOVING
ot::Srp::Client::ItemState::kRegistered
=
OT_SRP_CLIENT_ITEM_STATE_REGISTERED
ot::Srp::Client::ItemState::kRemoved
=
OT_SRP_CLIENT_ITEM_STATE_REMOVED
Examples
References
from
examples
Code
Location
Scope
Referrer
enum
ItemState
:
uint8_t
srp_client.hpp:85
DefineMapEnum
(
otSrpClientItemState
,
Srp
::
Client
::
ItemState
)
;
srp_client.hpp:1118
bool
Client
::
HostInfo
::
SetState
(
ItemState
aState
)
srp_client.cpp:63
ot::Srp::Client::HostInfo::SetState()
ot::Srp::Client::HostInfo::SetState()::aState
bool
Client
::
Service
::
SetState
(
ItemState
aState
)
srp_client.cpp:122
ot::Srp::Client::Service::SetState()
ot::Srp::Client::Service::SetState()::aState
static
const
ItemState
kNewStateOnStop
[
]
{
srp_client.cpp:443
ot::Srp::Client::Stop()
static
const
ItemState
kNewStateOnPause
[
]
{
srp_client.cpp:510
ot::Srp::Client::Pause()
bool
Client
::
ChangeHostAndServiceStates
(
const
ItemState
*
aNewStates
,
ServiceStateChangeMode
aMode
)
srp_client.cpp:921
ot::Srp::Client::ChangeHostAndServiceStates()
ot::Srp::Client::ChangeHostAndServiceStates()::aNewStates
ItemState
oldHostState
=
mHostInfo
.
GetState
(
)
;
srp_client.cpp:926
ot::Srp::Client::ChangeHostAndServiceStates()
static
const
ItemState
kNewStateOnMessageTx
[
]
{
srp_client.cpp:979
ot::Srp::Client::SendUpdate()
static
const
ItemState
kNewStateOnUpdateDone
[
]
{
srp_client.cpp:1762
ot::Srp::Client::ProcessResponse()
const
char
*
Client
::
ItemStateToString
(
ItemState
aState
)
srp_client.cpp:2544
ot::Srp::Client::ItemStateToString()
ot::Srp::Client::ItemStateToString()::aState
ItemState
GetState
(
void
)
const
{
return
static_cast
<
ItemState
>
(
mState
)
;
}
srp_client.hpp:159
ot::Srp::Client::HostInfo::GetState() const
bool
SetState
(
ItemState
aState
)
;
srp_client.hpp:163
ot::Srp::Client::HostInfo::SetState()
ot::Srp::Client::HostInfo::SetState()::aState
ItemState
GetState
(
void
)
const
{
return
static_cast
<
ItemState
>
(
mState
)
;
}
srp_client.hpp:259
ot::Srp::Client::Service::GetState() const
bool
SetState
(
ItemState
aState
)
;
srp_client.hpp:285
ot::Srp::Client::Service::SetState()
ot::Srp::Client::Service::SetState()::aState
bool
Matches
(
ItemState
aState
)
const
{
return
GetState
(
)
==
aState
;
}
srp_client.hpp:292
ot::Srp::Client::Service::Matches() const
static
const
char
*
ItemStateToString
(
ItemState
aState
)
;
srp_client.hpp:693
ot::Srp::Client::ItemStateToString()
ot::Srp::Client::ItemStateToString()::aState
bool
ChangeHostAndServiceStates
(
const
ItemState
*
aNewStates
,
ServiceStateChangeMode
aMode
)
;
srp_client.hpp:1018
ot::Srp::Client::ChangeHostAndServiceStates()
ot::Srp::Client::ChangeHostAndServiceStates()::aNewStates
DefineMapEnum
(
otSrpClientItemState
,
Srp
::
Client
::
ItemState
)
;
srp_client.hpp:1118
ot::MappedEnum::Type
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
return
ot::Srp::Client::HostInfo::GetState() const
srp_client.hpp:159
ot::Srp::Client::HostInfo::SetState()::aState
ot::Srp::Client::HostInfo::SetState()
srp_client.hpp:163
return
ot::Srp::Client::Service::GetState() const
srp_client.hpp:259
ot::Srp::Client::Service::SetState()::aState
ot::Srp::Client::Service::SetState()
srp_client.hpp:285
ot::Srp::Client::ItemStateToString()::aState
ot::Srp::Client::ItemStateToString()
srp_client.hpp:693
ot::Srp::Client::ChangeHostAndServiceStates()::aNewStates
ot::Srp::Client::ChangeHostAndServiceStates()
srp_client.hpp:1018
ot::MappedEnum::Type
srp_client.hpp:1118
ot::Srp::Client::HostInfo::SetState()::aState
ot::Srp::Client::HostInfo::SetState()
srp_client.cpp:63
ot::Srp::Client::Service::SetState()::aState
ot::Srp::Client::Service::SetState()
srp_client.cpp:122
ot::Srp::Client::ChangeHostAndServiceStates()::aNewStates
ot::Srp::Client::ChangeHostAndServiceStates()
srp_client.cpp:921
ot::Srp::Client::ItemStateToString()::aState
ot::Srp::Client::ItemStateToString()
srp_client.cpp:2544
Lifecycle
from
examples
All items filtered out
All items filtered out