A Discrete-Event Network Simulator
API
ns3::WifiTxTimer Class Reference

This class is used to handle the timer that a station starts when transmitting a frame that solicits a response. More...

#include "wifi-tx-timer.h"

+ Collaboration diagram for ns3::WifiTxTimer:

Public Types

typedef Callback< void, uint8_t, Ptr< const WifiMpdu >, const WifiTxVector & > MpduResponseTimeout
 MPDU response timeout callback typedef. More...
 
typedef Callback< void, uint8_t, WifiPsduMap *, const std::set< Mac48Address > *, std::size_t > PsduMapResponseTimeout
 PSDU map response timeout callback typedef. More...
 
typedef Callback< void, uint8_t, Ptr< const WifiPsdu >, const WifiTxVector & > PsduResponseTimeout
 PSDU response timeout callback typedef. More...
 
enum  Reason : uint8_t {
  NOT_RUNNING = 0 , WAIT_CTS , WAIT_NORMAL_ACK , WAIT_BLOCK_ACK ,
  WAIT_CTS_AFTER_MU_RTS , WAIT_NORMAL_ACK_AFTER_DL_MU_PPDU , WAIT_BLOCK_ACKS_IN_TB_PPDU , WAIT_TB_PPDU_AFTER_BASIC_TF ,
  WAIT_QOS_NULL_AFTER_BSRP_TF , WAIT_BLOCK_ACK_AFTER_TB_PPDU
}
 The reason why the timer was started. More...
 

Public Member Functions

 WifiTxTimer ()
 Default constructor. More...
 
virtual ~WifiTxTimer ()
 
void Cancel ()
 Cancel the timer. More...
 
Time GetDelayLeft () const
 Get the remaining time until the timer will expire. More...
 
Reason GetReason () const
 Get the reason why the timer was started. More...
 
std::string GetReasonString (Reason reason) const
 Get a string associated with the given reason. More...
 
const std::set< Mac48Address > & GetStasExpectedToRespond () const
 
void GotResponseFrom (const Mac48Address &from)
 Notify that a response was got from the given station. More...
 
bool IsRunning () const
 Return true if the timer is running. More...
 
void Reschedule (const Time &delay)
 Reschedule the timer to time out the given amount of time from the moment this function is called. More...
 
template<typename MEM , typename OBJ , typename... Args>
void Set (Reason reason, const Time &delay, const std::set< Mac48Address > &from, MEM mem_ptr, OBJ obj, Args... args)
 This method is called when a frame soliciting a response is transmitted. More...
 
void SetMpduResponseTimeoutCallback (MpduResponseTimeout callback) const
 Set the callback to invoke when the TX timer following the transmission of an MPDU expires. More...
 
void SetPsduMapResponseTimeoutCallback (PsduMapResponseTimeout callback) const
 Set the callback to invoke when the TX timer following the transmission of a PSDU map expires. More...
 
void SetPsduResponseTimeoutCallback (PsduResponseTimeout callback) const
 Set the callback to invoke when the TX timer following the transmission of a PSDU expires. More...
 

Private Member Functions

void Expire ()
 Internal callback invoked when the timer expires. More...
 
void FeedTraceSource (Ptr< WifiMpdu > item, WifiTxVector txVector)
 This method is called when the timer expires to feed the MPDU response timeout callback. More...
 
void FeedTraceSource (Ptr< WifiPsdu > psdu, WifiTxVector txVector)
 This method is called when the timer expires to feed the PSDU response timeout callback. More...
 
void FeedTraceSource (WifiPsduMap *psduMap, std::size_t nTotalStations)
 This method is called when the timer expires to feed the PSDU map response timeout callback. More...
 
template<typename MEM , typename OBJ , typename... Args>
void Timeout (MEM mem_ptr, OBJ obj, Args... args)
 This method is called when the timer expires. More...
 

Private Attributes

Time m_end
 the absolute time when the timer will expire More...
 
Ptr< EventImplm_impl
 the timer implementation, which contains the bound callback function and arguments More...
 
MpduResponseTimeout m_mpduResponseTimeoutCallback
 the MPDU response timeout callback More...
 
PsduMapResponseTimeout m_psduMapResponseTimeoutCallback
 the PSDU map response timeout callback More...
 
PsduResponseTimeout m_psduResponseTimeoutCallback
 the PSDU response timeout callback More...
 
Reason m_reason
 the reason why the timer was started More...
 
std::set< Mac48Addressm_staExpectResponseFrom
 the set of stations we expect to receive a response from More...
 
EventId m_timeoutEvent
 the timeout event after a missing response More...
 

Detailed Description

This class is used to handle the timer that a station starts when transmitting a frame that solicits a response.

The timeout can be rescheduled (multiple times) when the RXSTART.indication is received from the PHY.

Definition at line 48 of file wifi-tx-timer.h.

Member Typedef Documentation

◆ MpduResponseTimeout

MPDU response timeout callback typedef.

Definition at line 156 of file wifi-tx-timer.h.

◆ PsduMapResponseTimeout

typedef Callback<void, uint8_t, WifiPsduMap*, const std::set<Mac48Address>*, std::size_t> ns3::WifiTxTimer::PsduMapResponseTimeout

PSDU map response timeout callback typedef.

Definition at line 167 of file wifi-tx-timer.h.

◆ PsduResponseTimeout

PSDU response timeout callback typedef.

Definition at line 161 of file wifi-tx-timer.h.

Member Enumeration Documentation

◆ Reason

enum ns3::WifiTxTimer::Reason : uint8_t

The reason why the timer was started.

Enumerator
NOT_RUNNING 
WAIT_CTS 
WAIT_NORMAL_ACK 
WAIT_BLOCK_ACK 
WAIT_CTS_AFTER_MU_RTS 
WAIT_NORMAL_ACK_AFTER_DL_MU_PPDU 
WAIT_BLOCK_ACKS_IN_TB_PPDU 
WAIT_TB_PPDU_AFTER_BASIC_TF 
WAIT_QOS_NULL_AFTER_BSRP_TF 
WAIT_BLOCK_ACK_AFTER_TB_PPDU 

Definition at line 55 of file wifi-tx-timer.h.

Constructor & Destructor Documentation

◆ WifiTxTimer()

ns3::WifiTxTimer::WifiTxTimer ( )

Default constructor.

Definition at line 33 of file wifi-tx-timer.cc.

◆ ~WifiTxTimer()

ns3::WifiTxTimer::~WifiTxTimer ( )
virtual

Definition at line 41 of file wifi-tx-timer.cc.

References ns3::EventId::Cancel(), m_impl, and m_timeoutEvent.

+ Here is the call graph for this function:

Member Function Documentation

◆ Cancel()

◆ Expire()

void ns3::WifiTxTimer::Expire ( )
private

Internal callback invoked when the timer expires.

Definition at line 72 of file wifi-tx-timer.cc.

References m_end, m_impl, m_timeoutEvent, ns3::Simulator::Now(), NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

Referenced by Reschedule(), and Set().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ FeedTraceSource() [1/3]

void ns3::WifiTxTimer::FeedTraceSource ( Ptr< WifiMpdu item,
WifiTxVector  txVector 
)
private

This method is called when the timer expires to feed the MPDU response timeout callback.

Parameters
itemthe MPDU followed by no response
txVectorthe TXVECTOR used to transmit the MPDU

Definition at line 160 of file wifi-tx-timer.cc.

References ns3::Callback< R, UArgs >::IsNull(), m_mpduResponseTimeoutCallback, and m_reason.

Referenced by Timeout().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ FeedTraceSource() [2/3]

void ns3::WifiTxTimer::FeedTraceSource ( Ptr< WifiPsdu psdu,
WifiTxVector  txVector 
)
private

This method is called when the timer expires to feed the PSDU response timeout callback.

Parameters
psduthe PSDU followed by no response
txVectorthe TXVECTOR used to transmit the PSDU

Definition at line 175 of file wifi-tx-timer.cc.

References ns3::Callback< R, UArgs >::IsNull(), m_psduResponseTimeoutCallback, and m_reason.

+ Here is the call graph for this function:

◆ FeedTraceSource() [3/3]

void ns3::WifiTxTimer::FeedTraceSource ( WifiPsduMap psduMap,
std::size_t  nTotalStations 
)
private

This method is called when the timer expires to feed the PSDU map response timeout callback.

Parameters
psduMapthe PSDU map for which not all responses were received
nTotalStationsthe total number of expected responses

Definition at line 190 of file wifi-tx-timer.cc.

References ns3::Callback< R, UArgs >::IsNull(), m_psduMapResponseTimeoutCallback, m_reason, and m_staExpectResponseFrom.

+ Here is the call graph for this function:

◆ GetDelayLeft()

Time ns3::WifiTxTimer::GetDelayLeft ( ) const

Get the remaining time until the timer will expire.

Returns
the remaining time until the timer will expire. If the timer is not running, this method returns zero.

Definition at line 148 of file wifi-tx-timer.cc.

References m_end, and ns3::Simulator::Now().

Referenced by ns3::EhtFrameExchangeManager::UpdateTxopEndOnTxStart().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetReason()

WifiTxTimer::Reason ns3::WifiTxTimer::GetReason ( ) const

Get the reason why the timer was started.

Call this method only if the timer is running

Returns
the reason why the timer was started

Definition at line 88 of file wifi-tx-timer.cc.

References IsRunning(), m_reason, and NS_ASSERT.

Referenced by ns3::FrameExchangeManager::ReceiveMpdu(), and ns3::HtFrameExchangeManager::ReceiveMpdu().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetReasonString()

std::string ns3::WifiTxTimer::GetReasonString ( Reason  reason) const

Get a string associated with the given reason.

Parameters
reasonthe given reason
Returns
a string associated with the given reason

Definition at line 95 of file wifi-tx-timer.cc.

References CASE_REASON, NOT_RUNNING, and NS_ABORT_MSG.

Referenced by Cancel(), and Reschedule().

+ Here is the caller graph for this function:

◆ GetStasExpectedToRespond()

const std::set< Mac48Address > & ns3::WifiTxTimer::GetStasExpectedToRespond ( ) const
Returns
the set of stations that are still expected to respond

Definition at line 142 of file wifi-tx-timer.cc.

References m_staExpectResponseFrom.

Referenced by ns3::EhtFrameExchangeManager::PreProcessFrame(), ns3::QosFrameExchangeManager::TransmissionFailed(), and ns3::HeFrameExchangeManager::TransmissionSucceeded().

+ Here is the caller graph for this function:

◆ GotResponseFrom()

void ns3::WifiTxTimer::GotResponseFrom ( const Mac48Address from)

Notify that a response was got from the given station.

Parameters
fromthe MAC address of the given station

Definition at line 136 of file wifi-tx-timer.cc.

References m_staExpectResponseFrom.

◆ IsRunning()

◆ Reschedule()

void ns3::WifiTxTimer::Reschedule ( const Time delay)

Reschedule the timer to time out the given amount of time from the moment this function is called.

Note that nothing is done if the timer is not running.

Parameters
delaythe time to the expiration of the timer

Definition at line 48 of file wifi-tx-timer.cc.

References ns3::Time::As(), ns3::EventId::Cancel(), Expire(), GetReasonString(), ns3::EventId::IsRunning(), m_end, m_reason, m_timeoutEvent, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::Time::US.

Referenced by ns3::FrameExchangeManager::NotifySwitchingStartNow(), and ns3::FrameExchangeManager::RxStartIndication().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Set()

template<typename MEM , typename OBJ , typename... Args>
void ns3::WifiTxTimer::Set ( Reason  reason,
const Time delay,
const std::set< Mac48Address > &  from,
MEM  mem_ptr,
OBJ  obj,
Args...  args 
)

This method is called when a frame soliciting a response is transmitted.

This method starts a timer of the given duration and schedules a call to the given method in case the timer expires.

Template Parameters
MEM[deduced] Class method function signature type
OBJ[deduced] Class type of the object
Args[deduced] Type template parameter pack
Parameters
reasonthe reason why the timer was started
delaythe time to the expiration of the timer
fromthe set of stations we expect to receive a response from
mem_ptrMember method pointer to invoke
objThe object on which to invoke the member method
argsThe arguments to pass to the invoked method

Definition at line 268 of file wifi-tx-timer.h.

References check-style-clang-format::args, Expire(), m_end, m_impl, m_reason, m_staExpectResponseFrom, m_timeoutEvent, ns3::Simulator::Now(), ns3::Simulator::Schedule(), and Timeout().

Referenced by ns3::FrameExchangeManager::SendMpdu(), ns3::HeFrameExchangeManager::SendMuRts(), ns3::HtFrameExchangeManager::SendPsdu(), ns3::HeFrameExchangeManager::SendPsduMap(), and ns3::FrameExchangeManager::SendRts().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetMpduResponseTimeoutCallback()

void ns3::WifiTxTimer::SetMpduResponseTimeoutCallback ( MpduResponseTimeout  callback) const

Set the callback to invoke when the TX timer following the transmission of an MPDU expires.

Parameters
callbackthe callback to invoke when the TX timer following the transmission of an MPDU expires

Definition at line 154 of file wifi-tx-timer.cc.

References m_mpduResponseTimeoutCallback.

◆ SetPsduMapResponseTimeoutCallback()

void ns3::WifiTxTimer::SetPsduMapResponseTimeoutCallback ( PsduMapResponseTimeout  callback) const

Set the callback to invoke when the TX timer following the transmission of a PSDU map expires.

Parameters
callbackthe callback to invoke when the TX timer following the transmission of a PSDU map expires

Definition at line 184 of file wifi-tx-timer.cc.

References m_psduMapResponseTimeoutCallback.

◆ SetPsduResponseTimeoutCallback()

void ns3::WifiTxTimer::SetPsduResponseTimeoutCallback ( PsduResponseTimeout  callback) const

Set the callback to invoke when the TX timer following the transmission of a PSDU expires.

Parameters
callbackthe callback to invoke when the TX timer following the transmission of a PSDU expires

Definition at line 169 of file wifi-tx-timer.cc.

References m_psduResponseTimeoutCallback.

◆ Timeout()

template<typename MEM , typename OBJ , typename... Args>
void ns3::WifiTxTimer::Timeout ( MEM  mem_ptr,
OBJ  obj,
Args...  args 
)
private

This method is called when the timer expires.

It invokes the callbacks and the method set by the user.

Template Parameters
MEM[deduced] Class method function signature type
OBJ[deduced] Class type of the object
Args[deduced] Type template parameter pack
Parameters
mem_ptrMember method pointer to invoke
objThe object on which to invoke the member method
argsThe arguments to pass to the invoked method

Definition at line 293 of file wifi-tx-timer.h.

References check-style-clang-format::args, and FeedTraceSource().

Referenced by Set().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_end

Time ns3::WifiTxTimer::m_end
private

the absolute time when the timer will expire

Definition at line 245 of file wifi-tx-timer.h.

Referenced by Expire(), GetDelayLeft(), Reschedule(), and Set().

◆ m_impl

Ptr<EventImpl> ns3::WifiTxTimer::m_impl
private

the timer implementation, which contains the bound callback function and arguments

Definition at line 243 of file wifi-tx-timer.h.

Referenced by ~WifiTxTimer(), Cancel(), Expire(), and Set().

◆ m_mpduResponseTimeoutCallback

MpduResponseTimeout ns3::WifiTxTimer::m_mpduResponseTimeoutCallback
mutableprivate

the MPDU response timeout callback

Definition at line 250 of file wifi-tx-timer.h.

Referenced by FeedTraceSource(), and SetMpduResponseTimeoutCallback().

◆ m_psduMapResponseTimeoutCallback

PsduMapResponseTimeout ns3::WifiTxTimer::m_psduMapResponseTimeoutCallback
mutableprivate

the PSDU map response timeout callback

Definition at line 254 of file wifi-tx-timer.h.

Referenced by FeedTraceSource(), and SetPsduMapResponseTimeoutCallback().

◆ m_psduResponseTimeoutCallback

PsduResponseTimeout ns3::WifiTxTimer::m_psduResponseTimeoutCallback
mutableprivate

the PSDU response timeout callback

Definition at line 252 of file wifi-tx-timer.h.

Referenced by FeedTraceSource(), and SetPsduResponseTimeoutCallback().

◆ m_reason

Reason ns3::WifiTxTimer::m_reason
private

the reason why the timer was started

Definition at line 242 of file wifi-tx-timer.h.

Referenced by Cancel(), FeedTraceSource(), GetReason(), Reschedule(), and Set().

◆ m_staExpectResponseFrom

std::set<Mac48Address> ns3::WifiTxTimer::m_staExpectResponseFrom
private

the set of stations we expect to receive a response from

Definition at line 247 of file wifi-tx-timer.h.

Referenced by Cancel(), FeedTraceSource(), GetStasExpectedToRespond(), GotResponseFrom(), and Set().

◆ m_timeoutEvent

EventId ns3::WifiTxTimer::m_timeoutEvent
private

the timeout event after a missing response

Definition at line 241 of file wifi-tx-timer.h.

Referenced by ~WifiTxTimer(), Cancel(), Expire(), IsRunning(), Reschedule(), and Set().


The documentation for this class was generated from the following files: