openthread_sys

Function otLinkMetricsQuery

Source
pub unsafe extern "C" fn otLinkMetricsQuery(
    aInstance: *mut otInstance,
    aDestination: *const otIp6Address,
    aSeriesId: u8,
    aLinkMetricsFlags: *const otLinkMetrics,
    aCallback: otLinkMetricsReportCallback,
    aCallbackContext: *mut c_void,
) -> otError
Expand description

Sends an MLE Data Request to query Link Metrics.

It could be either Single Probe or Forward Tracking Series.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aDestination A pointer to the destination address. @param[in] aSeriesId The Series ID to query about, 0 for Single Probe. @param[in] aLinkMetricsFlags A pointer to flags specifying what metrics to query. @param[in] aCallback A pointer to a function that is called when Link Metrics report is received. @param[in] aCallbackContext A pointer to application-specific context.

@retval OT_ERROR_NONE Successfully sent a Link Metrics query message. @retval OT_ERROR_NO_BUFS Insufficient buffers to generate the MLE Data Request message. @retval OT_ERROR_UNKNOWN_NEIGHBOR @p aDestination is not link-local or the neighbor is not found. @retval OT_ERROR_NOT_CAPABLE The neighbor is not a Thread 1.2 device and does not support Link Metrics.