Multi Radio Link

This module includes definitions and functions for multi radio link.

Summary

Typedefs
otMultiRadioNeighborInfo typedef
This type represents multi radio link information associated with a neighbor.
otRadioLinkInfo typedef
This type represents information associated with a radio link.

Functions
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.

Structs
otMultiRadioNeighborInfo

This type represents multi radio link information associated with a neighbor.

otRadioLinkInfo

This type represents information associated with a radio link.

Typedefs

otMultiRadioNeighborInfo

struct otMultiRadioNeighborInfo otMultiRadioNeighborInfo

This type represents multi radio link information associated with a neighbor.

otRadioLinkInfo

struct otRadioLinkInfo otRadioLinkInfo

This type represents information associated with a radio link.

Functions

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).

Details
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.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.