ot::Trel::Link class

Represents a Thread Radio Encapsulation Link (TREL).

Syntax

Show:

Summary

Declaration

from trel_link.hpp:69

class Link : public InstanceLocator { friend class ot::Instance; friend class ot::Notifier; friend class Interface; public: static constexpr uint16_t kMtuSize = 1280 - 48 - sizeof(Header); static constexpr uint8_t kFcsSize = 0; explicit Link(Instance &aInstance); void SetPanId(Mac::PanId aPanId) { mPanId = aPanId; } void HandleExtAddressChange(void) { mInterface.HandleExtAddressChange(); } void Enable(void); void Disable(void); void Sleep(void); void Receive(uint8_t aChannel); Mac::TxFrame &GetTransmitFrame(void) { return mTxFrame; } void Send(void); private: static constexpr uint16_t kMaxHeaderSize = sizeof(Header); static constexpr uint16_t k154AckFrameSize = 3 + kFcsSize; static constexpr int8_t kRxRssi = -20; static constexpr uint32_t kAckWaitWindow = 750; static constexpr uint16_t kFcfFramePending = 1 << 4; enum State : uint8_t { kStateDisabled, kStateSleep, kStateReceive, kStateTransmit, }; void AfterInit(void); void SetState(State aState); void BeginTransmit(void); void InvokeSendDone(Error aError) { InvokeSendDone(aError, nullptr); } void InvokeSendDone(Error aError, Mac::RxFrame *aAckFrame); void ProcessReceivedPacket(Packet &aPacket); void HandleAck(Packet &aAckPacket); void SendAck(Packet &aRxPacket); void ReportDeferredAckStatus(Neighbor &aNeighbor, Error aError); void HandleTimer(Neighbor &aNeighbor); void HandleNotifierEvents(Events aEvents); void HandleTxTasklet(void); void HandleTimer(void); static const char *StateToString(State aState); using TxTasklet = TaskletIn<Link, &Link::HandleTxTasklet>; using TimeoutTimer = TimerMilliIn<Link, &Link::HandleTimer>; State mState; uint8_t mRxChannel; Mac::PanId mPanId; uint32_t mTxPacketNumber; TxTasklet mTxTasklet; TimeoutTimer mTimer; Interface mInterface; Mac::RxFrame mRxFrame; Mac::TxFrame mTxFrame; uint8_t mTxPacketBuffer[kMaxHeaderSize + kMtuSize]; uint8_t mAckPacketBuffer[kMaxHeaderSize]; uint8_t mAckFrameBuffer[k154AckFrameSize]; };

Fields

Methods

SetPanId()

Sets the PAN Identifier.

HandleExtAddressChange()

Notifies TREL radio link that device's extended MAC address has changed for it to update any internal address/state.

Enable()

Enables the TREL radio link.

Disable()

Disables the TREL radio link.

Sleep()

Requests TREL radio link to transition to Sleep mode.

Receive()

Requests TREL radio link to transition to Receive mode on a given channel. `Mac::HandleReceivedFrame()` is used to notify MAC layer upon receiving a frame.

GetTransmitFrame()

Gets the radio transmit frame for TREL radio link.

Send()

Requests a frame to be sent over TREL radio link. The frame should be already placed in `GetTransmitFrame()` frame. `Mac::RecordFrameTransmitStatus()` and `Mac::HandleTransmitDone()` are used to notify the success or error status of frame transmission upon completion of send.