Multi Radio Link
This module includes definitions and functions for multi radio link.
Classes | |
struct | otRadioLinkInfo |
This type represents information associated with a radio link. | |
struct | otMultiRadioNeighborInfo |
This type represents multi radio link information associated with a neighbor. |
Typedefs | |
typedef struct otRadioLinkInfo | otRadioLinkInfo |
This type represents information associated with a radio link. | |
typedef struct otMultiRadioNeighborInfo | otMultiRadioNeighborInfo |
This type represents multi radio link information associated with a neighbor. |
Functions | |
otError | otMultiRadioGetNeighborInfo (otInstance *aInstance, const otExtAddress *aExtAddress, otMultiRadioNeighborInfo *aNeighborInfo) |
This function gets the multi radio link information associated with a neighbor with a given Extended Address. |
Detailed Description
This module includes definitions and functions for multi radio link.
Function Documentation
◆ otMultiRadioGetNeighborInfo()
otError otMultiRadioGetNeighborInfo | ( | otInstance * | aInstance, |
const otExtAddress * | aExtAddress, |
||
otMultiRadioNeighborInfo * | aNeighborInfo |
||
) |
This function gets the multi radio link information associated with a neighbor with a given Extended Address.
This function requires the multi radio link feature to be enabled (please see config/radio_link.h
).
- Parameters
-
[in] aInstance
A pointer to an OpenThread instance. [in] aExtAddress
The Extended Address of neighbor. [out] aNeighborInfo
A pointer to otMultiRadioNeighborInfo
to output the neighbor info (on success).
- Return values
-
OT_ERROR_NONE
Neighbor was found and aNeighborInfo
was updated successfully.OT_ERROR_NOT_FOUND
Could not find a neighbor with aExtAddress
.