otLinkMetricsConfigureEnhAckProbing() function

Sets/clears Enhanced-ACK Based Probing for a specific Initiator. Can start/stop Enhanced-ACK Based Probing for a neighbor that has the address @p aShortAddress and @p aExtAddress. Once the Probing is started, the device would record the Link Metrics data of link layer frames sent from that neighbor and include the data into header IE in Enhanced-ACK sent to that neighbor.

Syntax

Show:

Summary

Declaration

from link_metrics.h:74

otError otLinkMetricsConfigureEnhAckProbing(otShortAddress aShortAddress, const otExtAddress *aExtAddress, otLinkMetrics aLinkMetrics);

Arguments

Argument

Description

aShortAddress

The short address of the Initiator.

aExtAddress

A pointer to the extended address of the Initiator.

aLinkMetrics

Flags specifying what metrics to query (Pdu Count would be omitted). When @p aLinkMetrics is equal to `0`, this method clears the Initiator.

Return value

OT_ERROR_NONE Successfully configured the Enhanced-ACK Based Probing. OT_ERROR_INVALID_ARGS @p aExtAddress is `nullptr`. OT_ERROR_NOT_FOUND The Initiator indicated by @p aShortAddress is not found when trying to clear. OT_ERROR_NO_BUFS No more Initiator can be supported.

Examples

References

from examples

otLinkMetricsConfigureEnhAckProbing() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle