ot::Mac::SubMac::Callbacks class

Defines the callbacks notifying `SubMac` user of changes and events.

Syntax

Show:

Summary

Declaration

from sub_mac.hpp:113

class Callbacks : public InstanceLocator { public: explicit Callbacks(Instance &aInstance); void ReceiveDone(RxFrame *aFrame, Error aError); void RecordCcaStatus(bool aCcaSuccess, uint8_t aChannel); void RecordFrameTransmitStatus(const TxFrame &aFrame, Error aError, uint8_t aRetryCount, bool aWillRetx); void TransmitDone(TxFrame &aFrame, RxFrame *aAckFrame, Error aError); void EnergyScanDone(int8_t aMaxRssi); void FrameCounterUsed(uint32_t aFrameCounter); };

Methods

ReceiveDone()

Notifies user of `SubMac` of a received frame.

RecordCcaStatus()

Notifies user of `SubMac` of CCA status (success/failure) for a frame transmission attempt. This is intended for updating counters, logging, and/or tracking CCA failure rate statistics.

RecordFrameTransmitStatus()

Notifies user of `SubMac` of the status of a frame transmission attempt. This is intended for updating counters, logging, and/or collecting statistics.

TransmitDone()

The method notifies user of `SubMac` that the transmit operation has completed, providing, if applicable, the received ACK frame.

EnergyScanDone()

Notifies user of `SubMac` that energy scan is complete.

FrameCounterUsed()

Notifies user of `SubMac` that a specific MAC frame counter is used for transmission. It is possible that this callback is invoked out of order in terms of counter values (i.e., called for a smaller counter value after a call for a larger counter value).

Examples

References

from examples

ot::Mac::SubMac::Callbacks class

Syntax

Methods

ReceiveDone()

RecordCcaStatus()

RecordFrameTransmitStatus()

TransmitDone()

EnergyScanDone()

FrameCounterUsed()

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle