ESP-IDF
ot::Message::GetLinkInfo() const
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading (2/5)...
Files
loading (3/5)...
Summary
Syntax
Arguments
Related
Examples
References
Call Tree
Data Use
Class Tree
Override Tree
Implementations
Instances
Lifecycle
SourceVu
ESP-IDF Framework and Examples
ESP-IDF
ot::Message::GetLinkInfo() const
ot::Message::GetLinkInfo() const method
Retrieves `ThreadLinkInfo` from the message if received over Thread radio with origin `kOriginThreadNetif`. @pram[out] aLinkInfo A reference to a `ThreadLinkInfo` to populate.
Syntax
Show:
Summary
Declaration
Definition
from
message.hpp:1358
Error
GetLinkInfo
(
ThreadLinkInfo
&
aLinkInfo
)
const
;
Implemented in
message.cpp:799
Arguments
Argument
aLinkInfo
Return value
kErrorNone Successfully retrieved the link info, @p `aLinkInfo` is updated. kErrorNotFound Message origin is not `kOriginThreadNetif`.
Related Functions
Found 1 other functions taking a
ThreadLinkInfo
argument:
Function
Description
ot::Message::UpdateLinkInfoFrom()
Sets the message's link info properties (PAN ID, link security, RSS) from a given `ThreadLinkInfo`.
Examples
References
from
examples
Code
Location
Error
Message
::
GetLinkInfo
(
ThreadLinkInfo
&
aLinkInfo
)
const
message.cpp:799
Error
GetLinkInfo
(
ThreadLinkInfo
&
aLinkInfo
)
const
;
message.hpp:1358
Call Tree
from
examples
ot::Message::GetLinkInfo() const
calls 8 functions:
All items filtered out
ot::Message::GetLinkInfo() const
ot::Message::GetPanId() const
ot::Message::IsDstPanIdBroadcast() const
ot::Message::GetChannel() const
ot::Message::IsOriginThreadNetif() const
ot::Message::IsLinkSecurityEnabled() const
ot::Message::GetAverageRss() const
ot::Message::GetAverageLqi() const
ot::Message::GetLinkInfo() const::aLinkInfo
All items filtered out
Data Use
from
examples
ot::Message::GetLinkInfo() const
reads 2 variables and writes 6 variables:
ot::kErrorNone
ot::kErrorNotFound
All items filtered out
ot::Message::GetLinkInfo() const
otThreadLinkInfo::mPanId
otThreadLinkInfo::mChannel
otThreadLinkInfo::mRss
otThreadLinkInfo::mLqi
otThreadLinkInfo::mLinkSecurity
otThreadLinkInfo::mIsDstPanIdBroadcast
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
Lifecycle
from
examples
All items filtered out
All items filtered out