openthread_sys

Function otLinkMetricsConfigEnhAckProbing

Source
pub unsafe extern "C" fn otLinkMetricsConfigEnhAckProbing(
    aInstance: *mut otInstance,
    aDestination: *const otIp6Address,
    aEnhAckFlags: otLinkMetricsEnhAckFlags,
    aLinkMetricsFlags: *const otLinkMetrics,
    aCallback: otLinkMetricsMgmtResponseCallback,
    aCallbackContext: *mut c_void,
    aEnhAckCallback: otLinkMetricsEnhAckProbingIeReportCallback,
    aEnhAckCallbackContext: *mut c_void,
) -> otError
Expand description

Sends an MLE Link Metrics Management Request to configure/clear an Enhanced-ACK Based Probing. This functionality requires OT_LINK_METRICS_INITIATOR feature enabled.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aDestination A pointer to the destination address. @param[in] aEnhAckFlags Enh-ACK Flags to indicate whether to register or clear the probing. 0 to clear and 1 to register. Other values are reserved. @param[in] aLinkMetricsFlags A pointer to flags specifying what metrics to query. Should be NULL when aEnhAckFlags is 0. @param[in] aCallback A pointer to a function that is called when an Enhanced Ack with Link Metrics is received. @param[in] aCallbackContext A pointer to application-specific context.

@retval OT_ERROR_NONE Successfully sent a Link Metrics Management Request message. @retval OT_ERROR_NO_BUFS Insufficient buffers to generate the MLE Link Metrics Management Request message. @retval OT_ERROR_INVALID_ARGS @p aEnhAckFlags is not a valid value or @p aLinkMetricsFlags isn’t correct. @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.