ot::MessageQueue class

Implements a message queue.

Syntax

Show:

Summary

Declaration

Definition

from message.hpp:146

class MessageQueue; class PriorityQueue; class ThreadLinkInfo; class Buffer : public otMessageBuffer, public LinkedListEntry<Buffer> { friend class Message; public: Buffer *GetNextBuffer(void) { return GetNext(); } const Buffer *GetNextBuffer(void) const { return GetNext(); } void SetNextBuffer(Buffer *aNext) { SetNext(aNext); } protected: struct Metadata { bool mDirectTx : 1; bool mLinkSecurity : 1; bool mInPriorityQ : 1; bool mTxSuccess : 1; bool mDoNotEvict : 1; bool mMulticastLoop : 1; bool mResolvingAddress : 1; bool mAllowLookbackToHost : 1; bool mIsDstPanIdBroadcast : 1; #if OPENTHREAD_CONFIG_MULTI_RADIO bool mIsRadioTypeSet : 1; #endif #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE bool mTimeSync : 1; #endif uint8_t mPriority : 2; uint8_t mOrigin : 2; #if OPENTHREAD_CONFIG_MULTI_RADIO uint8_t mRadioType : 2; static_assert(Mac::kNumRadioTypes <= (1 << 2), "mRadioType bitfield cannot store all radio type values"); #endif uint8_t mType : 3; uint8_t mSubType : 4; uint8_t mMleCommand; uint8_t mChannel; #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE uint8_t mTimeSyncSeq; #endif uint16_t mLength; uint16_t mOffset; uint16_t mReserved; uint16_t mMeshDest; uint16_t mPanId; uint32_t mDatagramTag; #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE int64_t mNetworkTimeOffset; #endif TimeMilli mTimestamp; Message *mNext; Message *mPrev; MessagePool *mMessagePool; void *mQueue; RssAverager mRssAverager; LqiAverager mLqiAverager; #if OPENTHREAD_FTD ChildMask mChildMask; #endif }; static_assert(kBufferSize > sizeof(Metadata) + sizeof(otMessageBuffer), "Metadata does not fit in a single buffer"); static constexpr uint16_t kBufferDataSize = kBufferSize - sizeof(otMessageBuffer); static constexpr uint16_t kHeadBufferDataSize = kBufferDataSize - sizeof(Metadata); Metadata &GetMetadata(void) { return mBuffer.mHead.mMetadata; } const Metadata &GetMetadata(void) const { return mBuffer.mHead.mMetadata; } uint8_t *GetFirstData(void) { return mBuffer.mHead.mData; } const uint8_t *GetFirstData(void) const { return mBuffer.mHead.mData; } uint8_t *GetData(void) { return mBuffer.mData; } const uint8_t *GetData(void) const { return mBuffer.mData; } private: union { struct { Metadata mMetadata; uint8_t mData[kHeadBufferDataSize]; } mHead; uint8_t mData[kBufferDataSize]; } mBuffer; }; static_assert(sizeof(Buffer) >= kBufferSize, "Buffer size is not valid. Increase OPENTHREAD_CONFIG_MESSAGE_BUFFER_SIZE."); class Message : public otMessage, public Buffer, public GetProvider<Message> { friend class Checksum; friend class Crypto::HmacSha256; friend class Crypto::Sha256; friend class Crypto::AesCcm; friend class MessagePool; friend class MessageQueue; friend class PriorityQueue; public: enum Type : uint8_t { kTypeIp6 = 0, kType6lowpan = 1, kTypeSupervision = 2, kTypeMacEmptyData = 3, kTypeIp4 = 4, kTypeBle = 5, kTypeOther = 6, }; enum SubType : uint8_t { kSubTypeNone = 0, kSubTypeMle = 1, kSubTypeMplRetransmission = 2, kSubTypeJoinerEntrust = 3, kSubTypeJoinerFinalizeResponse = 4, }; enum Priority : uint8_t { kPriorityLow = OT_MESSAGE_PRIORITY_LOW, kPriorityNormal = OT_MESSAGE_PRIORITY_NORMAL, kPriorityHigh = OT_MESSAGE_PRIORITY_HIGH, kPriorityNet = OT_MESSAGE_PRIORITY_HIGH + 1, }; static constexpr uint8_t kNumPriorities = 4; enum LinkSecurityMode : bool { kNoLinkSecurity = false, kWithLinkSecurity = true, }; enum Ownership : uint8_t { kTakeCustody, kCopyToUse, }; enum Origin : uint8_t { kOriginThreadNetif = OT_MESSAGE_ORIGIN_THREAD_NETIF, kOriginHostTrusted = OT_MESSAGE_ORIGIN_HOST_TRUSTED, kOriginHostUntrusted = OT_MESSAGE_ORIGIN_HOST_UNTRUSTED, }; class Settings : public otMessageSettings { public: Settings(LinkSecurityMode aSecurityMode, Priority aPriority); explicit Settings(Priority aPriority) : Settings(kWithLinkSecurity, aPriority) { } Priority GetPriority(void) const { return static_cast<Priority>(mPriority); } bool IsLinkSecurityEnabled(void) const { return mLinkSecurityEnabled; } static const Settings &From(const otMessageSettings *aSettings); static const Settings &GetDefault(void) { return static_cast<const Settings &>(kDefault); } private: static const otMessageSettings kDefault; }; template <typename DataType> class FooterData { public: Error AppendTo(Message &aMessage) const { return aMessage.Append<DataType>(AsDataType()); } void ReadFrom(const Message &aMessage) { IgnoreError(aMessage.Read<DataType>(aMessage.GetLength() - sizeof(DataType), AsDataType())); } void UpdateIn(Message &aMessage) const { aMessage.Write<DataType>(aMessage.GetLength() - sizeof(DataType), AsDataType()); } void RemoveFrom(Message &aMessage) const { aMessage.RemoveFooter(sizeof(DataType)); } protected: FooterData(void) = default; private: const DataType &AsDataType(void) const { return static_cast<const DataType &>(*this); } DataType &AsDataType(void) { return static_cast<DataType &>(*this); } }; Instance &GetInstance(void) const; void Free(void); Message *GetNext(void) const; uint16_t GetLength(void) const { return GetMetadata().mLength; } Error SetLength(uint16_t aLength); uint8_t GetBufferCount(void) const; uint16_t GetOffset(void) const { return GetMetadata().mOffset; } void MoveOffset(int aDelta); void SetOffset(uint16_t aOffset); Type GetType(void) const { return static_cast<Type>(GetMetadata().mType); } void SetType(Type aType) { GetMetadata().mType = aType; } SubType GetSubType(void) const { return static_cast<SubType>(GetMetadata().mSubType); } void SetSubType(SubType aSubType) { GetMetadata().mSubType = aSubType; } bool IsSubTypeMle(void) const { return (GetSubType() == kSubTypeMle); } bool IsMleCommand(Mle::Command aMleCommand) const; Mle::Command GetMleCommand(void) const { return static_cast<Mle::Command>(GetMetadata().mMleCommand); } void SetMleCommand(Mle::Command aMleCommand) { GetMetadata().mMleCommand = aMleCommand; } bool GetMulticastLoop(void) const { return GetMetadata().mMulticastLoop; } void SetMulticastLoop(bool aMulticastLoop) { GetMetadata().mMulticastLoop = aMulticastLoop; } Priority GetPriority(void) const { return static_cast<Priority>(GetMetadata().mPriority); } Error SetPriority(Priority aPriority); static const char *PriorityToString(Priority aPriority); Error PrependBytes(const void *aBuf, uint16_t aLength); template <typename ObjectType> Error Prepend(const ObjectType &aObject) { static_assert(!TypeTraits::IsPointer<ObjectType>::kValue, "ObjectType must not be a pointer"); return PrependBytes(&aObject, sizeof(ObjectType)); } void RemoveHeader(uint16_t aLength); void RemoveHeader(uint16_t aOffset, uint16_t aLength); Error InsertHeader(uint16_t aOffset, uint16_t aLength); void RemoveFooter(uint16_t aLength); Error AppendBytes(const void *aBuf, uint16_t aLength); Error AppendBytesFromMessage(const Message &aMessage, uint16_t aOffset, uint16_t aLength); Error AppendBytesFromMessage(const Message &aMessage, const OffsetRange &aOffsetRange); template <typename ObjectType> Error Append(const ObjectType &aObject) { static_assert(!TypeTraits::IsPointer<ObjectType>::kValue, "ObjectType must not be a pointer"); return AppendBytes(&aObject, sizeof(ObjectType)); } template <DataLengthType kDataLengthType> Error AppendData(const Data<kDataLengthType> &aData) { return AppendBytes(aData.GetBytes(), aData.GetLength()); } uint16_t ReadBytes(uint16_t aOffset, void *aBuf, uint16_t aLength) const; uint16_t ReadBytes(const OffsetRange &aOffsetRange, void *aBuf) const; Error Read(uint16_t aOffset, void *aBuf, uint16_t aLength) const; Error Read(const OffsetRange &aOffsetRange, void *aBuf, uint16_t aLength) const; template <typename ObjectType> Error Read(uint16_t aOffset, ObjectType &aObject) const { static_assert(!TypeTraits::IsPointer<ObjectType>::kValue, "ObjectType must not be a pointer"); return Read(aOffset, &aObject, sizeof(ObjectType)); } template <typename ObjectType> Error Read(const OffsetRange &aOffsetRange, ObjectType &aObject) const { static_assert(!TypeTraits::IsPointer<ObjectType>::kValue, "ObjectType must not be a pointer"); return Read(aOffsetRange, &aObject, sizeof(ObjectType)); } bool CompareBytes(uint16_t aOffset, const void *aBuf, uint16_t aLength, ByteMatcher aMatcher = nullptr) const; bool CompareBytes(uint16_t aOffset, const Message &aOtherMessage, uint16_t aOtherOffset, uint16_t aLength, ByteMatcher aMatcher = nullptr) const; template <typename ObjectType> bool Compare(uint16_t aOffset, const ObjectType &aObject) const { static_assert(!TypeTraits::IsPointer<ObjectType>::kValue, "ObjectType must not be a pointer"); return CompareBytes(aOffset, &aObject, sizeof(ObjectType)); } void WriteBytes(uint16_t aOffset, const void *aBuf, uint16_t aLength); void WriteBytesFromMessage(uint16_t aWriteOffset, const Message &aMessage, uint16_t aReadOffset, uint16_t aLength); template <typename ObjectType> void Write(uint16_t aOffset, const ObjectType &aObject) { static_assert(!TypeTraits::IsPointer<ObjectType>::kValue, "ObjectType must not be a pointer"); WriteBytes(aOffset, &aObject, sizeof(ObjectType)); } template <DataLengthType kDataLengthType> void WriteData(uint16_t aOffset, const Data<kDataLengthType> &aData) { WriteBytes(aOffset, aData.GetBytes(), aData.GetLength()); } Message *Clone(uint16_t aLength) const; Message *Clone(void) const { return Clone(GetLength()); } uint32_t GetDatagramTag(void) const { return GetMetadata().mDatagramTag; } void SetDatagramTag(uint32_t aTag) { GetMetadata().mDatagramTag = aTag; } #if OPENTHREAD_FTD ChildMask &GetIndirectTxChildMask(void) { return GetMetadata().mChildMask; } const ChildMask &GetIndirectTxChildMask(void) const { return GetMetadata().mChildMask; } #endif uint16_t GetMeshDest(void) const { return GetMetadata().mMeshDest; } void SetMeshDest(uint16_t aMeshDest) { GetMetadata().mMeshDest = aMeshDest; } uint16_t GetPanId(void) const { return GetMetadata().mPanId; } void SetPanId(uint16_t aPanId) { GetMetadata().mPanId = aPanId; } bool IsDstPanIdBroadcast(void) const { return GetMetadata().mIsDstPanIdBroadcast; } uint8_t GetChannel(void) const { return GetMetadata().mChannel; } void SetChannel(uint8_t aChannel) { GetMetadata().mChannel = aChannel; } TimeMilli GetTimestamp(void) const { return GetMetadata().mTimestamp; } void SetTimestamp(TimeMilli aTimestamp) { GetMetadata().mTimestamp = aTimestamp; } void SetTimestampToNow(void) { SetTimestamp(TimerMilli::GetNow()); } bool IsDirectTransmission(void) const { return GetMetadata().mDirectTx; } void ClearDirectTransmission(void) { GetMetadata().mDirectTx = false; } void SetDirectTransmission(void) { GetMetadata().mDirectTx = true; } bool GetTxSuccess(void) const { return GetMetadata().mTxSuccess; } void SetTxSuccess(bool aTxSuccess) { GetMetadata().mTxSuccess = aTxSuccess; } bool GetDoNotEvict(void) const { return GetMetadata().mDoNotEvict; } void SetDoNotEvict(bool aDoNotEvict) { GetMetadata().mDoNotEvict = aDoNotEvict; } bool IsResolvingAddress(void) const { return GetMetadata().mResolvingAddress; } void SetResolvingAddress(bool aResolvingAddress) { GetMetadata().mResolvingAddress = aResolvingAddress; } bool IsLoopbackToHostAllowed(void) const { return GetMetadata().mAllowLookbackToHost; } void SetLoopbackToHostAllowed(bool aAllowLoopbackToHost) { GetMetadata().mAllowLookbackToHost = aAllowLoopbackToHost; } Origin GetOrigin(void) const { return static_cast<Origin>(GetMetadata().mOrigin); } void SetOrigin(Origin aOrigin) { GetMetadata().mOrigin = aOrigin; } bool IsOriginThreadNetif(void) const { return GetOrigin() == kOriginThreadNetif; } bool IsOriginHostTrusted(void) const { return GetOrigin() == kOriginHostTrusted; } bool IsOriginHostUntrusted(void) const { return GetOrigin() == kOriginHostUntrusted; } bool IsLinkSecurityEnabled(void) const { return GetMetadata().mLinkSecurity; } void SetLinkSecurityEnabled(bool aEnabled) { GetMetadata().mLinkSecurity = aEnabled; } void AddRss(int8_t aRss) { IgnoreError(GetMetadata().mRssAverager.Add(aRss)); } int8_t GetAverageRss(void) const { return GetMetadata().mRssAverager.GetAverage(); } const RssAverager &GetRssAverager(void) const { return GetMetadata().mRssAverager; } void AddLqi(uint8_t aLqi) { GetMetadata().mLqiAverager.Add(aLqi); } uint8_t GetAverageLqi(void) const { return GetMetadata().mLqiAverager.GetAverage(); } uint8_t GetPsduCount(void) const { return GetMetadata().mLqiAverager.GetCount(); } const LqiAverager &GetLqiAverager(void) const { return GetMetadata().mLqiAverager; } Error GetLinkInfo(ThreadLinkInfo &aLinkInfo) const; void UpdateLinkInfoFrom(const ThreadLinkInfo &aLinkInfo); MessageQueue *GetMessageQueue(void) const { return !GetMetadata().mInPriorityQ ? static_cast<MessageQueue *>(GetMetadata().mQueue) : nullptr; } PriorityQueue *GetPriorityQueue(void) const { return GetMetadata().mInPriorityQ ? static_cast<PriorityQueue *>(GetMetadata().mQueue) : nullptr; } bool IsTimeSync(void) const; #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE void SetTimeSync(bool aEnabled) { GetMetadata().mTimeSync = aEnabled; } void SetNetworkTimeOffset(int64_t aNetworkTimeOffset) { GetMetadata().mNetworkTimeOffset = aNetworkTimeOffset; } int64_t GetNetworkTimeOffset(void) const { return GetMetadata().mNetworkTimeOffset; } void SetTimeSyncSeq(uint8_t aTimeSyncSeq) { GetMetadata().mTimeSyncSeq = aTimeSyncSeq; } uint8_t GetTimeSyncSeq(void) const { return GetMetadata().mTimeSyncSeq; } #endif #if OPENTHREAD_CONFIG_MULTI_RADIO bool IsRadioTypeSet(void) const { return GetMetadata().mIsRadioTypeSet; } Mac::RadioType GetRadioType(void) const { return static_cast<Mac::RadioType>(GetMetadata().mRadioType); } void SetRadioType(Mac::RadioType aRadioType) { GetMetadata().mIsRadioTypeSet = true; GetMetadata().mRadioType = aRadioType; } void ClearRadioType(void) { GetMetadata().mIsRadioTypeSet = false; } #endif protected: class ConstIterator : public ItemPtrIterator<const Message, ConstIterator> { friend class ItemPtrIterator<const Message, ConstIterator >; public: ConstIterator(void) = default; explicit ConstIterator(const Message *aMessage) : ItemPtrIterator(aMessage) { } private: void Advance(void) { mItem = mItem->GetNext(); } }; class Iterator : public ItemPtrIterator<Message, Iterator> { friend class ItemPtrIterator<Message, Iterator >; public: Iterator(void) : mNext(nullptr) { } explicit Iterator(Message *aMessage) : ItemPtrIterator(aMessage) , mNext(NextMessage(aMessage)) { } private: void Advance(void); static Message *NextMessage(Message *aMessage) { return (aMessage != nullptr) ? aMessage->GetNext() : nullptr; } Message *mNext; }; uint16_t GetReserved(void) const { return GetMetadata().mReserved; } void SetReserved(uint16_t aReservedHeader) { GetMetadata().mReserved = aReservedHeader; } private: class Chunk : public Data<kWithUint16Length> { public: const Buffer *GetBuffer(void) const { return mBuffer; } void SetBuffer(const Buffer *aBuffer) { mBuffer = aBuffer; } private: const Buffer *mBuffer; }; class MutableChunk : public Chunk { public: uint8_t *GetBytes(void) { return AsNonConst(Chunk::GetBytes()); } }; void GetFirstChunk(uint16_t aOffset, uint16_t &aLength, Chunk &aChunk) const; void GetNextChunk(uint16_t &aLength, Chunk &aChunk) const; void GetFirstChunk(uint16_t aOffset, uint16_t &aLength, MutableChunk &aChunk) { AsConst(this)->GetFirstChunk(aOffset, aLength, static_cast<Chunk &>(aChunk)); } void GetNextChunk(uint16_t &aLength, MutableChunk &aChunk) { AsConst(this)->GetNextChunk(aLength, static_cast<Chunk &>(aChunk)); } MessagePool *GetMessagePool(void) const { return GetMetadata().mMessagePool; } void SetMessagePool(MessagePool *aMessagePool) { GetMetadata().mMessagePool = aMessagePool; } bool IsInAQueue(void) const { return (GetMetadata().mQueue != nullptr); } void SetMessageQueue(MessageQueue *aMessageQueue); void SetPriorityQueue(PriorityQueue *aPriorityQueue); void SetRssAverager(const RssAverager &aRssAverager) { GetMetadata().mRssAverager = aRssAverager; } void SetLqiAverager(const LqiAverager &aLqiAverager) { GetMetadata().mLqiAverager = aLqiAverager; } Message *&Next(void) { return GetMetadata().mNext; } Message *const &Next(void) const { return GetMetadata().mNext; } Message *&Prev(void) { return GetMetadata().mPrev; } static Message *NextOf(Message *aMessage) { return (aMessage != nullptr) ? aMessage->Next() : nullptr; } static const Message *NextOf(const Message *aMessage) { return (aMessage != nullptr) ? aMessage->Next() : nullptr; } Error ResizeMessage(uint16_t aLength); }; class MessageQueue : public otMessageQueue;

Implemented in message.hpp:1568

Methods

GetHead()

Returns a pointer to the first message.

GetHead() const

Returns a pointer to the first message.

Enqueue()

Adds a message at a given position (head/tail) of the list.

Enqueue()

Adds a message at a given position (head/tail) of the list.

Dequeue()

Removes a message from the list.

DequeueAndFree()

Removes a message from the queue and frees it.

DequeueAndFreeAll()

Removes and frees all messages from the queue.

GetInfo() const

Gets the information about number of messages and buffers in the queue. Updates `aInfo` and adds number of message/buffers in the message queue to the corresponding member variable in `aInfo`. The caller needs to make sure `aInfo` is initialized before calling this method (e.g., clearing `aInfo`). Same `aInfo` can be passed in multiple calls of `GetInfo(aInfo)` on different queues to add up the number of messages/buffers on different queues.

ot::MessageQueue class

Syntax

Methods

GetHead()

GetHead() const

Enqueue()

Enqueue()

Dequeue()

DequeueAndFree()

DequeueAndFreeAll()

GetInfo() const

begin()

end()

begin() const

end() const

GetTail()

GetTail() const

SetTail()

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle