Symbols ![]()
loading...
Files ![]()
loading...
ot::IndirectSender class
Implements indirect transmission.
Syntax
class IndirectSender : public InstanceLocator,
public IndirectSenderBase,
private NonCopyable
{
friend class Instance;
friend class DataPollHandler::Callbacks;
#if OPENTHREAD_FTD && OPENTHREAD_CONFIG_MAC_CSL_TRANSMITTER_ENABLE
friend class CslTxScheduler::Callbacks;
#endif
public:
class ChildInfo
{
friend class IndirectSender;
friend class DataPollHandler;
friend class CslTxScheduler;
friend class SourceMatchController;
public:
uint16_t GetIndirectMessageCount(void) const { return mQueuedMessageCount; }
private:
Message *GetIndirectMessage(void) { return mIndirectMessage; }
void SetIndirectMessage(Message *aMessage) { mIndirectMessage = aMessage; }
uint16_t GetIndirectFragmentOffset(void) const { return mIndirectFragmentOffset; }
void SetIndirectFragmentOffset(uint16_t aFragmentOffset) { mIndirectFragmentOffset = aFragmentOffset; }
bool GetIndirectTxSuccess(void) const { return mIndirectTxSuccess; }
void SetIndirectTxSuccess(bool aTxStatus) { mIndirectTxSuccess = aTxStatus; }
bool IsIndirectSourceMatchShort(void) const { return mUseShortAddress; }
void SetIndirectSourceMatchShort(bool aShort) { mUseShortAddress = aShort; }
bool IsIndirectSourceMatchPending(void) const { return mSourceMatchPending; }
void SetIndirectSourceMatchPending(bool aPending) { mSourceMatchPending = aPending; }
void IncrementIndirectMessageCount(void) { mQueuedMessageCount++; }
void DecrementIndirectMessageCount(void) { mQueuedMessageCount--; }
void ResetIndirectMessageCount(void) { mQueuedMessageCount = 0; }
bool IsWaitingForMessageUpdate(void) const { return mWaitingForMessageUpdate; }
void SetWaitingForMessageUpdate(bool aNeedsUpdate) { mWaitingForMessageUpdate = aNeedsUpdate; }
const Mac::Address &GetMacAddress(Mac::Address &aMacAddress) const;
Message *mIndirectMessage;
uint16_t mIndirectFragmentOffset : 14;
bool mIndirectTxSuccess : 1;
bool mWaitingForMessageUpdate : 1;
uint16_t mQueuedMessageCount : 14;
bool mUseShortAddress : 1;
bool mSourceMatchPending : 1;
static_assert(OPENTHREAD_CONFIG_NUM_MESSAGE_BUFFERS < (1UL << 14),
"mQueuedMessageCount cannot fit max required!");
};
typedef bool (&MessageChecker)(const Message &aMessage);
explicit IndirectSender(Instance &aInstance);
void Start(void) { mEnabled = true; }
void Stop(void);
void AddMessageForSleepyChild(Message &aMessage, Child &aChild);
Error RemoveMessageFromSleepyChild(Message &aMessage, Child &aChild);
void ClearAllMessagesForSleepyChild(Child &aChild);
Message *FindQueuedMessageForSleepyChild(const Child &aChild, MessageChecker aChecker)
{
return AsNonConst(AsConst(this)->FindQueuedMessageForSleepyChild(aChild, aChecker));
}
const Message *FindQueuedMessageForSleepyChild(const Child &aChild, MessageChecker aChecker) const;
bool HasQueuedMessageForSleepyChild(const Child &aChild, MessageChecker aChecker) const
{
return (FindQueuedMessageForSleepyChild(aChild, aChecker) != nullptr);
}
void SetChildUseShortAddress(Child &aChild, bool aUseShortAddress);
void HandleChildModeChange(Child &aChild, Mle::DeviceMode aOldMode);
private:
Error PrepareFrameForChild(Mac::TxFrame &aFrame, FrameContext &aContext, Child &aChild);
void HandleSentFrameToChild(const Mac::TxFrame &aFrame, const FrameContext &aContext, Error aError, Child &aChild);
void HandleFrameChangeDone(Child &aChild);
void UpdateIndirectMessage(Child &aChild);
void RequestMessageUpdate(Child &aChild);
uint16_t PrepareDataFrame(Mac::TxFrame &aFrame, Child &aChild, Message &aMessage);
void PrepareEmptyFrame(Mac::TxFrame &aFrame, Child &aChild, bool aAckRequest);
void ClearMessagesForRemovedChildren(void);
static bool AcceptAnyMessage(const Message &aMessage);
static bool AcceptSupervisionMessage(const Message &aMessage);
bool mEnabled;
SourceMatchController mSourceMatchController;
DataPollHandler mDataPollHandler;
#if OPENTHREAD_FTD && OPENTHREAD_CONFIG_MAC_CSL_TRANSMITTER_ENABLE
CslTxScheduler mCslTxScheduler;
#endif
};
Fields
References
Code
Location
Scope
Referrer
Class Tree
ot::IndirectSender is inherited by 3 classess:
Instances
Instance
Scope
Location
Project