Symbols

Files

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::DataPollSender

ot::DataPollSender class

Implements the data poll (mac data request command) sender.

Syntax

Show:

Summary

Declaration

from data_poll_sender.hpp:62

class DataPollSender : public InstanceLocator, private NonCopyable { public: static constexpr uint8_t kDefaultFastPolls = 8; static constexpr uint8_t kMaxFastPolls = 15; static constexpr uint8_t kMaxFastPollsUsers = 63; explicit DataPollSender(Instance &aInstance); void StartPolling(void); void StopPolling(void); Error SendDataPoll(void); Error SetExternalPollPeriod(uint32_t aPeriod); uint32_t GetExternalPollPeriod(void) const { return mExternalPollPeriod; } void HandlePollSent(Mac::TxFrame &aFrame, Error aError); void HandlePollTimeout(void); void ProcessRxFrame(const Mac::RxFrame &aFrame); #if OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2 void ProcessTxDone(const Mac::TxFrame &aFrame, const Mac::RxFrame *aAckFrame, Error aError); #endif void RecalculatePollPeriod(void); void SetAttachMode(bool aMode); void SendFastPolls(uint8_t aNumFastPolls = 0); void StopFastPolls(void); uint32_t GetKeepAlivePollPeriod(void) const; void ResetKeepAliveTimer(void); uint32_t GetDefaultPollPeriod(void) const; Mac::TxFrame *PrepareDataRequest(Mac::TxFrames &aTxFrames); private: static constexpr uint8_t kQuickPollsAfterTimeout = 5; static constexpr uint8_t kMaxPollRetxAttempts = OPENTHREAD_CONFIG_FAILED_CHILD_TRANSMISSIONS; static constexpr uint8_t kMaxCslPollRetxAttempts = OPENTHREAD_CONFIG_MAC_DEFAULT_MAX_FRAME_RETRIES_DIRECT; enum PollPeriodSelector : uint8_t { kUsePreviousPollPeriod, kRecalculatePollPeriod, }; static constexpr uint32_t kAttachDataPollPeriod = OPENTHREAD_CONFIG_MAC_ATTACH_DATA_POLL_PERIOD; static constexpr uint32_t kRetxPollPeriod = OPENTHREAD_CONFIG_MAC_RETX_POLL_PERIOD; static constexpr uint32_t kFastPollPeriod = 188; static constexpr uint32_t kMinPollPeriod = OPENTHREAD_CONFIG_MAC_MINIMUM_POLL_PERIOD; static constexpr uint32_t kMaxExternalPeriod = ((1 << 26) - 1); void ScheduleNextPoll(PollPeriodSelector aPollPeriodSelector); uint32_t CalculatePollPeriod(void) const; const Neighbor &GetParent(void) const; void HandlePollTimer(void) { IgnoreError(SendDataPoll()); } #if OPENTHREAD_CONFIG_MULTI_RADIO Error GetPollDestinationAddress(Mac::Address &aDest, Mac::RadioType &aRadioType) const; #else Error GetPollDestinationAddress(Mac::Address &aDest) const; #endif using PollTimer = TimerMilliIn<DataPollSender, &DataPollSender::HandlePollTimer>; TimeMilli mTimerStartTime; uint32_t mPollPeriod; uint32_t mExternalPollPeriod : 26; uint8_t mFastPollsUsers : 6; PollTimer mTimer; bool mEnabled : 1; bool mAttachMode : 1; bool mRetxMode : 1; uint8_t mPollTimeoutCounter : 4; uint8_t mPollTxFailureCounter : 4; uint8_t mRemainingFastPolls : 4; };

Fields

Field

Declared as

ot::DataPollSender::kDefaultFastPolls

ot::DataPollSender::kMaxFastPolls

ot::DataPollSender::kMaxFastPollsUsers

ot::DataPollSender::kQuickPollsAfterTimeout

ot::DataPollSender::kMaxPollRetxAttempts

ot::DataPollSender::kMaxCslPollRetxAttempts

ot::DataPollSender::kAttachDataPollPeriod

ot::DataPollSender::kRetxPollPeriod

ot::DataPollSender::kFastPollPeriod

ot::DataPollSender::kMinPollPeriod

ot::DataPollSender::kMaxExternalPeriod

ot::DataPollSender::mTimerStartTime

TimeMilli

ot::DataPollSender::mPollPeriod

uint32_t

ot::DataPollSender::mExternalPollPeriod

uint32_t : 26

ot::DataPollSender::mFastPollsUsers

uint8_t : 6

ot::DataPollSender::mTimer

PollTimer

ot::DataPollSender::mEnabled

bool : 1

ot::DataPollSender::mAttachMode

bool : 1

ot::DataPollSender::mRetxMode

bool : 1

ot::DataPollSender::mPollTimeoutCounter

uint8_t : 4

ot::DataPollSender::mPollTxFailureCounter

uint8_t : 4

ot::DataPollSender::mRemainingFastPolls

uint8_t : 4

Methods

StartPolling()

Instructs the data poll sender to start sending periodic data polls.

StopPolling()

Instructs the data poll sender to stop sending periodic data polls.

SendDataPoll()

Enqueues a data poll (an IEEE 802.15.4 Data Request) message.

SetExternalPollPeriod()

Sets/clears a user-specified/external data poll period. Value of zero for `aPeriod` clears the user-specified poll period. If the user provides a non-zero poll period, the user value specifies the maximum period between data request transmissions. Note that OpenThread may send data request transmissions more frequently when expecting a control-message from a parent or in case of data poll transmission failures or timeouts, or when the specified value is larger than the child timeout. A non-zero `aPeriod` should be larger than or equal to `OPENTHREAD_CONFIG_MAC_MINIMUM_POLL_PERIOD` (10ms) or this method returns `kErrorInvalidArgs`. If a non-zero `aPeriod` is larger than maximum value of `0x3FFFFFF ((1 << 26) - 1)`, it would be clipped to this value.

GetExternalPollPeriod() const

Gets the current user-specified/external data poll period.

HandlePollSent()

Informs the data poll sender of success/error status of a previously requested poll frame transmission. In case of transmit failure, the data poll sender may choose to send the next data poll more quickly (up to some fixed number of attempts).

HandlePollTimeout()

Informs the data poll sender that a data poll timeout happened, i.e., when the ack in response to a data request command indicated that a frame was pending, but no frame was received after timeout interval. Data poll sender may choose to transmit another data poll immediately (up to some fixed number of attempts).

ProcessRxFrame()

Informs the data poll sender to process a received MAC frame.

ProcessTxDone()

Informs the data poll sender to process a transmitted MAC frame.

RecalculatePollPeriod()

Asks the data poll sender to recalculate the poll period. This is mainly used to inform the poll sender that a parameter impacting the poll period (e.g., the child's timeout value which is used to determine the default data poll period) is modified.

SetAttachMode()

Sets/clears the attach mode on data poll sender. When attach mode is enabled, the data poll sender will send data polls at a faster rate determined by poll period configuration option `OPENTHREAD_CONFIG_MAC_ATTACH_DATA_POLL_PERIOD`.

SendFastPolls()

Asks data poll sender to send the next given number of polls at a faster rate (poll period defined by `kFastPollPeriod`). This is used by OpenThread stack when it expects a response from the parent/sender. If @p aNumFastPolls is zero the default value specified by `kDefaultFastPolls` is used instead. The number of fast polls is clipped by maximum value specified by `kMaxFastPolls`. Note that per `SendFastPolls()` would increase the internal reference count until up to the allowed maximum value. If there are retransmission mechanism in the caller component, it should be responsible to call `StopFastPolls()` the same times as `SendFastPolls()` it triggered to decrease the reference count properly, guaranteeing to exit fast poll mode gracefully. Otherwise, fast poll would continue until all data polls are sent out.

StopFastPolls()

Asks data poll sender to stop fast polls when the expecting response is received.

GetKeepAlivePollPeriod() const

Gets the maximum data polling period in use. The maximum data poll period is determined based as the minimum of the user-specified poll interval and the default poll interval.

ResetKeepAliveTimer()

Resets the timer for sending keep-alive messages.

GetDefaultPollPeriod() const

Returns the default maximum poll period. The default poll period is determined based on the child timeout interval, ensuing the child would send data poll within the child's timeout.