template <typename TxType>

class TxFrameProperties

Defined at line 319 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

Defines a CRTP base class providing property accessors for a transmitted radio frame.

Users of this class should follow CRTP-style inheritance, where the `TxType` class inherits from

`TxFrameProperties

<TxType

>`.

The `TxType` class MUST provide a `GetFrame()` method returning a reference to the associated `Frame` with the

following signature:

const Frame

&GetFrame

(void) const;

Template Parameters

TxType The frame or frame-info type.

Public Methods

void SetChannel (uint8_t aChannel)

Sets the channel on which to send the frame.

It also sets the `RxChannelAfterTxDone` to the same channel.

Parameters

aChannel [in] The channel used for transmission.

Defined at line 331 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void SetTxPower (int8_t aTxPower)

Sets TX power to send the frame.

Parameters

aTxPower [in] The tx power used for transmission.

Defined at line 342 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

uint8_t GetRxChannelAfterTxDone ()

Gets the RX channel after frame TX is done.

Defined at line 349 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void SetRxChannelAfterTxDone (uint8_t aChannel)

Sets the RX channel after frame TX is done.

Parameters

aChannel [in] The RX channel after frame TX is done.

Defined at line 356 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

uint8_t GetMaxCsmaBackoffs ()

Returns the maximum number of backoffs the CSMA-CA algorithm will attempt before declaring a channel

access failure.

Equivalent to macMaxCSMABackoffs in IEEE 802.15.4-2006.

Defined at line 367 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void SetMaxCsmaBackoffs (uint8_t aMaxCsmaBackoffs)

Sets the maximum number of backoffs the CSMA-CA algorithm will attempt before declaring a channel

access failure.

Equivalent to macMaxCSMABackoffs in IEEE 802.15.4-2006.

Parameters

aMaxCsmaBackoffs [in] The maximum number of backoffs the CSMA-CA algorithm will attempt before declaringa channel access failure.

Defined at line 378 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

uint8_t GetMaxFrameRetries ()

Returns the maximum number of retries allowed after a transmission failure.

Equivalent to macMaxFrameRetries in IEEE 802.15.4-2006.

Defined at line 387 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void SetMaxFrameRetries (uint8_t aMaxFrameRetries)

Sets the maximum number of retries allowed after a transmission failure.

Equivalent to macMaxFrameRetries in IEEE 802.15.4-2006.

Parameters

aMaxFrameRetries [in] The maximum number of retries allowed after a transmission failure.

Defined at line 396 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

bool IsARetransmission ()

Indicates whether or not the frame is a retransmission.

Defined at line 404 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void SetIsARetransmission (bool aIsARetx)

Sets the retransmission flag attribute.

Parameters

aIsARetx [in] TRUE if frame is a retransmission of an earlier frame, FALSE otherwise.

Defined at line 411 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

bool IsCsmaCaEnabled ()

Indicates whether or not CSMA-CA is enabled.

Defined at line 419 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void SetCsmaCaEnabled (bool aCsmaCaEnabled)

Sets the CSMA-CA enabled attribute.

Parameters

aCsmaCaEnabled [in] TRUE if CSMA-CA must be enabled for this packet, FALSE otherwise.

Defined at line 426 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

const Mac::KeyMaterial & GetAesKey ()

Returns the key used for frame encryption and authentication (AES CCM).

Defined at line 433 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void SetAesKey (const Mac::KeyMaterial & aAesKey)

Sets the key used for frame encryption and authentication (AES CCM).

Parameters

aAesKey [in] The key.

Defined at line 440 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

bool IsSecurityProcessed ()

Indicates whether or not the frame has security processed.

Defined at line 448 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void SetIsSecurityProcessed (bool aIsSecurityProcessed)

Sets the security processed flag attribute.

Parameters

aIsSecurityProcessed [in] TRUE if the frame already has security processed.

Defined at line 455 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

bool IsCslIePresent ()

Indicates whether or not the frame contains the CSL IE.

Defined at line 466 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void SetCslIePresent (bool aCslPresent)

Sets the CSL IE present flag.

Parameters

aCslPresent [in] TRUE if the frame contains the CSL IE.

Defined at line 473 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

bool IsHeaderUpdated ()

Indicates whether or not the frame header is updated.

Defined at line 481 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void SetIsHeaderUpdated (bool aIsHeaderUpdated)

Sets the header updated flag attribute.

Parameters

aIsHeaderUpdated [in] TRUE if the frame header is updated.

Defined at line 488 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

bool IsTargetTxTimeSpecified ()

Indicates whether or not a target transmission time is specified for the frame.

Defined at line 529 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

Time32 GetTargetTxTime ()

Gets the target transmission time for the frame as a `Time32`.

Defined at line 536 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void ClearTargetTxTime ()

Clears the target transmission time for the frame (sets delay and base time to zero).

Defined at line 541 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp

void SetTargetTxTime (Time64 aTargetTxTime, Time64 aBaseTime)

Sets the target transmission time and base reference time for the frame.

Parameters

aTargetTxTime [in] The target transmission time.

aBaseTime [in] The base reference time.

Defined at line 553 of file ../../third_party/openthread/src/core/radio/radio_frame.hpp