A Discrete-Event Network Simulator
API
ChannelAccessManagerTest< TxopType > Class Template Reference

Channel Access Manager Test. More...

+ Inheritance diagram for ChannelAccessManagerTest< TxopType >:
+ Collaboration diagram for ChannelAccessManagerTest< TxopType >:

Public Member Functions

 ChannelAccessManagerTest ()
 
void DoRun (void)
 Implementation to actually run this TestCase. More...
 
void DoRun (void)
 Implementation to actually run this TestCase. More...
 
void DoRun (void) override
 Implementation to actually run this TestCase. More...
 
void GenerateBackoff (uint32_t i)
 Generate backoff function. More...
 
void NotifyAccessGranted (uint32_t i)
 Notify access granted function. More...
 
void NotifyChannelSwitching (void)
 Notify channel switching function. More...
 
void NotifyInternalCollision (Ptr< TxopTest< TxopType > > state)
 Notify internal collision function. More...
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName (void) const
 
TestCaseoperator= (const TestCase &)=delete
 

Private Types

typedef std::vector< Ptr< TxopTest< TxopType > > > TxopTests
 the TXOP tests typedef More...
 

Private Member Functions

void AddAccessRequest (uint64_t at, uint64_t txTime, uint64_t expectedGrantTime, uint32_t from)
 Add access function. More...
 
void AddAccessRequestWithAckTimeout (uint64_t at, uint64_t txTime, uint64_t expectedGrantTime, uint32_t from)
 Add access request with Ack timeout. More...
 
void AddAccessRequestWithSuccessfullAck (uint64_t at, uint64_t txTime, uint64_t expectedGrantTime, uint32_t ackDelay, uint32_t from)
 Add access request with successful ack. More...
 
void AddAckTimeoutReset (uint64_t at)
 Add Ack timeout reset function. More...
 
void AddCcaBusyEvt (uint64_t at, uint64_t duration, WifiChannelListType channelType=WIFI_CHANLIST_PRIMARY, const std::vector< Time > &per20MhzDurations={})
 Add CCA busy event function. More...
 
void AddNavReset (uint64_t at, uint64_t duration)
 Add NAV reset function. More...
 
void AddNavStart (uint64_t at, uint64_t duration)
 Add NAV start function. More...
 
void AddRxErrorEvt (uint64_t at, uint64_t duration)
 Add receive error event function for error at end of frame. More...
 
void AddRxErrorEvt (uint64_t at, uint64_t duration, uint64_t timeUntilError)
 Add receive error event function for error during frame. More...
 
void AddRxInsideSifsEvt (uint64_t at, uint64_t duration)
 Add receive inside SIFS event function. More...
 
void AddRxOkEvt (uint64_t at, uint64_t duration)
 Add receive OK event function. More...
 
void AddRxStartEvt (uint64_t at, uint64_t duration)
 Add receive start event function. More...
 
void AddSwitchingEvt (uint64_t at, uint64_t duration)
 Add switching event function. More...
 
void AddTxEvt (uint64_t at, uint64_t duration)
 Add transmit event function. More...
 
void AddTxop (uint32_t aifsn)
 Add Txop function. More...
 
void DoAccessRequest (uint64_t txTime, uint64_t expectedGrantTime, Ptr< TxopTest< TxopType > > state)
 Add access request with successful Ack. More...
 
void DoCheckBusy (bool busy)
 Perform check that channel access manager is busy or idle. More...
 
void EndTest (void)
 End test function. More...
 
void ExpectBackoff (uint64_t time, uint32_t nSlots, uint32_t from)
 Expect generate backoff function. More...
 
void ExpectBusy (uint64_t time, bool busy)
 Schedule a check that the channel access manager is busy or idle. More...
 
void ExpectInternalCollision (uint64_t time, uint32_t nSlots, uint32_t from)
 Expect internal collision function. More...
 
void StartTest (uint64_t slotTime, uint64_t sifs, uint64_t eifsNoDifsNoSifs, uint32_t ackTimeoutValue=20, uint16_t chWidth=20)
 Start test function. More...
 

Private Attributes

uint32_t m_ackTimeoutValue
 the Ack timeout value More...
 
Ptr< ChannelAccessManagerStubm_ChannelAccessManager
 the channel access manager More...
 
Ptr< FrameExchangeManagerStub< TxopType > > m_feManager
 the Frame Exchange Manager stubbed More...
 
Ptr< WifiPhym_phy
 the PHY object More...
 
TxopTests m_txop
 the vector of Txop test instances More...
 

Additional Inherited Members

- Public Types inherited from ns3::TestCase
enum  TestDuration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
 How long the test takes to execute. More...
 
- Protected Member Functions inherited from ns3::TestCase
 TestCase (std::string name)
 Constructor. More...
 
void AddTestCase (TestCase *testCase, TestDuration duration=QUICK)
 Add an individual child TestCase to this test suite. More...
 
TestCaseGetParent () const
 Get the parent of this TestCsse. More...
 
bool IsStatusFailure (void) const
 Check if any tests failed. More...
 
bool IsStatusSuccess (void) const
 Check if all tests passed. More...
 
void SetDataDir (std::string directory)
 Set the data directory where reference trace files can be found. More...
 
void ReportTestFailure (std::string cond, std::string actual, std::string limit, std::string message, std::string file, int32_t line)
 Log the failure of this TestCase. More...
 
bool MustAssertOnFailure (void) const
 Check if this run should assert on failure. More...
 
bool MustContinueOnFailure (void) const
 Check if this run should continue on failure. More...
 
std::string CreateDataDirFilename (std::string filename)
 Construct the full path to a file in the data directory. More...
 
std::string CreateTempDirFilename (std::string filename)
 Construct the full path to a file in a temporary directory. More...
 

Detailed Description

template<typename TxopType>
class ChannelAccessManagerTest< TxopType >

Channel Access Manager Test.

Definition at line 214 of file channel-access-manager-test.cc.

Member Typedef Documentation

◆ TxopTests

template<typename TxopType >
typedef std::vector<Ptr<TxopTest<TxopType> > > ChannelAccessManagerTest< TxopType >::TxopTests
private

the TXOP tests typedef

Definition at line 389 of file channel-access-manager-test.cc.

Constructor & Destructor Documentation

◆ ChannelAccessManagerTest()

Member Function Documentation

◆ AddAccessRequest()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddAccessRequest ( uint64_t  at,
uint64_t  txTime,
uint64_t  expectedGrantTime,
uint32_t  from 
)
private

Add access function.

Parameters
atthe event time
txTimethe transmit time
expectedGrantTimethe expected grant time
fromthe index of the requesting Txop

Definition at line 698 of file channel-access-manager-test.cc.

◆ AddAccessRequestWithAckTimeout()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddAccessRequestWithAckTimeout ( uint64_t  at,
uint64_t  txTime,
uint64_t  expectedGrantTime,
uint32_t  from 
)
private

Add access request with Ack timeout.

Parameters
attime to schedule DoAccessRequest event
txTimethe transmit time
expectedGrantTimethe expected grant time
fromthe index of the requesting Txop

Definition at line 706 of file channel-access-manager-test.cc.

References ChannelAccessManagerTest< TxopType >::DoAccessRequest(), ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ AddAccessRequestWithSuccessfullAck()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddAccessRequestWithSuccessfullAck ( uint64_t  at,
uint64_t  txTime,
uint64_t  expectedGrantTime,
uint32_t  ackDelay,
uint32_t  from 
)
private

Add access request with successful ack.

Parameters
attime to schedule DoAccessRequest event
txTimethe transmit time
expectedGrantTimethe expected grant time
ackDelaythe delay of the Ack after txEnd
fromthe index of the requesting Txop

Definition at line 716 of file channel-access-manager-test.cc.

References ChannelAccessManagerTest< TxopType >::DoAccessRequest(), ns3::MicroSeconds(), ns3::Now(), and NS_ASSERT.

+ Here is the call graph for this function:

◆ AddAckTimeoutReset()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddAckTimeoutReset ( uint64_t  at)
private

Add Ack timeout reset function.

Parameters
atthe event time

Definition at line 690 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ AddCcaBusyEvt()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddCcaBusyEvt ( uint64_t  at,
uint64_t  duration,
WifiChannelListType  channelType = WIFI_CHANLIST_PRIMARY,
const std::vector< Time > &  per20MhzDurations = {} 
)
private

Add CCA busy event function.

Parameters
atthe event time
durationthe duration
channelTypethe channel type
per20MhzDurationsvector that indicates for how long each 20 MHz subchannel is busy

Definition at line 741 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ AddNavReset()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddNavReset ( uint64_t  at,
uint64_t  duration 
)
private

Add NAV reset function.

Parameters
atthe event time
durationthe duration

Definition at line 672 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ AddNavStart()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddNavStart ( uint64_t  at,
uint64_t  duration 
)
private

Add NAV start function.

Parameters
atthe event time
durationthe duration

Definition at line 681 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ AddRxErrorEvt() [1/2]

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddRxErrorEvt ( uint64_t  at,
uint64_t  duration 
)
private

Add receive error event function for error at end of frame.

Parameters
atthe event time
durationthe duration

Definition at line 646 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ AddRxErrorEvt() [2/2]

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddRxErrorEvt ( uint64_t  at,
uint64_t  duration,
uint64_t  timeUntilError 
)
private

Add receive error event function for error during frame.

Parameters
atthe event time
durationthe duration
timeUntilErrorthe time after event time to force the error

Definition at line 657 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), ns3::Now(), and ns3::WIFI_CHANLIST_PRIMARY.

+ Here is the call graph for this function:

◆ AddRxInsideSifsEvt()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddRxInsideSifsEvt ( uint64_t  at,
uint64_t  duration 
)
private

Add receive inside SIFS event function.

Parameters
atthe event time
durationthe duration

Definition at line 637 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ AddRxOkEvt()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddRxOkEvt ( uint64_t  at,
uint64_t  duration 
)
private

Add receive OK event function.

Parameters
atthe event time
durationthe duration

Definition at line 626 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ AddRxStartEvt()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddRxStartEvt ( uint64_t  at,
uint64_t  duration 
)
private

Add receive start event function.

Parameters
atthe event time
durationthe duration

Definition at line 761 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ AddSwitchingEvt()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddSwitchingEvt ( uint64_t  at,
uint64_t  duration 
)
private

Add switching event function.

Parameters
atthe event time
durationthe duration

Definition at line 752 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ AddTxEvt()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddTxEvt ( uint64_t  at,
uint64_t  duration 
)
private

Add transmit event function.

Parameters
atthe event time
durationthe duration

Definition at line 478 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ AddTxop()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::AddTxop ( uint32_t  aifsn)
private

Add Txop function.

Parameters
aifsnthe AIFSN

Definition at line 591 of file channel-access-manager-test.cc.

◆ DoAccessRequest()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::DoAccessRequest ( uint64_t  txTime,
uint64_t  expectedGrantTime,
Ptr< TxopTest< TxopType > >  state 
)
private

Add access request with successful Ack.

Parameters
txTimethe transmit time
expectedGrantTimethe expected grant time
stateTxopTest

Definition at line 728 of file channel-access-manager-test.cc.

Referenced by ChannelAccessManagerTest< TxopType >::AddAccessRequestWithAckTimeout(), and ChannelAccessManagerTest< TxopType >::AddAccessRequestWithSuccessfullAck().

+ Here is the caller graph for this function:

◆ DoCheckBusy()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::DoCheckBusy ( bool  busy)
private

Perform check that channel access manager is busy or idle.

Parameters
busywhether expected state is busy

Definition at line 562 of file channel-access-manager-test.cc.

References NS_TEST_EXPECT_MSG_EQ.

Referenced by ChannelAccessManagerTest< TxopType >::ExpectBusy().

+ Here is the caller graph for this function:

◆ DoRun() [1/3]

void ChannelAccessManagerTest< Txop >::DoRun ( void  )
virtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 773 of file channel-access-manager-test.cc.

◆ DoRun() [2/3]

void ChannelAccessManagerTest< QosTxop >::DoRun ( void  )
virtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 1115 of file channel-access-manager-test.cc.

References ns3::WIFI_CHANLIST_SECONDARY, ns3::WIFI_CHANLIST_SECONDARY40, and ns3::WIFI_CHANLIST_SECONDARY80.

◆ DoRun() [3/3]

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::DoRun ( void  )
overridevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

◆ EndTest()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::EndTest ( void  )
private

End test function.

Definition at line 601 of file channel-access-manager-test.cc.

References NS_TEST_EXPECT_MSG_EQ.

◆ ExpectBackoff()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::ExpectBackoff ( uint64_t  time,
uint32_t  nSlots,
uint32_t  from 
)
private

Expect generate backoff function.

Parameters
timethe expected time
nSlotsthe number of slots
fromthe expected from

Definition at line 543 of file channel-access-manager-test.cc.

References TxopTest< TxopType >::m_expectedBackoff.

◆ ExpectBusy()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::ExpectBusy ( uint64_t  time,
bool  busy 
)
private

Schedule a check that the channel access manager is busy or idle.

Parameters
timethe expected time
busywhether the manager is expected to be busy

Definition at line 554 of file channel-access-manager-test.cc.

References ChannelAccessManagerTest< TxopType >::DoCheckBusy(), ns3::MicroSeconds(), and ns3::Now().

+ Here is the call graph for this function:

◆ ExpectInternalCollision()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::ExpectInternalCollision ( uint64_t  time,
uint32_t  nSlots,
uint32_t  from 
)
private

Expect internal collision function.

Parameters
timethe expected time
nSlotsthe number of slots
fromthe expected from

Definition at line 532 of file channel-access-manager-test.cc.

References TxopTest< TxopType >::m_expectedInternalCollision.

◆ GenerateBackoff()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::GenerateBackoff ( uint32_t  i)

Generate backoff function.

Parameters
ithe index of the Txop

Definition at line 501 of file channel-access-manager-test.cc.

References TxopTest< TxopType >::m_expectedBackoff, and NS_TEST_EXPECT_MSG_EQ.

◆ NotifyAccessGranted()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::NotifyAccessGranted ( uint32_t  i)

Notify access granted function.

Parameters
ithe index of the Txop

Definition at line 462 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), ns3::Now(), and NS_TEST_EXPECT_MSG_EQ.

+ Here is the call graph for this function:

◆ NotifyChannelSwitching()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::NotifyChannelSwitching ( void  )

Notify channel switching function.

Definition at line 516 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), ns3::Now(), and NS_TEST_EXPECT_MSG_EQ.

+ Here is the call graph for this function:

◆ NotifyInternalCollision()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::NotifyInternalCollision ( Ptr< TxopTest< TxopType > >  state)

Notify internal collision function.

Parameters
statethe Txop

Definition at line 487 of file channel-access-manager-test.cc.

References TxopTest< TxopType >::m_expectedInternalCollision, and NS_TEST_EXPECT_MSG_EQ.

◆ StartTest()

template<typename TxopType >
void ChannelAccessManagerTest< TxopType >::StartTest ( uint64_t  slotTime,
uint64_t  sifs,
uint64_t  eifsNoDifsNoSifs,
uint32_t  ackTimeoutValue = 20,
uint16_t  chWidth = 20 
)
private

Start test function.

Parameters
slotTimethe slot time
sifsthe SIFS
eifsNoDifsNoSifsthe EIFS no DIFS no SIFS
ackTimeoutValuethe Ack timeout value
chWidththe channel width in MHz

Definition at line 569 of file channel-access-manager-test.cc.

References ns3::MicroSeconds(), ns3::WIFI_PHY_BAND_UNSPECIFIED, and ns3::WIFI_STANDARD_80211ac.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_ackTimeoutValue

template<typename TxopType >
uint32_t ChannelAccessManagerTest< TxopType >::m_ackTimeoutValue
private

the Ack timeout value

Definition at line 395 of file channel-access-manager-test.cc.

◆ m_ChannelAccessManager

template<typename TxopType >
Ptr<ChannelAccessManagerStub> ChannelAccessManagerTest< TxopType >::m_ChannelAccessManager
private

the channel access manager

Definition at line 392 of file channel-access-manager-test.cc.

◆ m_feManager

template<typename TxopType >
Ptr<FrameExchangeManagerStub<TxopType> > ChannelAccessManagerTest< TxopType >::m_feManager
private

the Frame Exchange Manager stubbed

Definition at line 391 of file channel-access-manager-test.cc.

◆ m_phy

template<typename TxopType >
Ptr<WifiPhy> ChannelAccessManagerTest< TxopType >::m_phy
private

the PHY object

Definition at line 393 of file channel-access-manager-test.cc.

◆ m_txop

template<typename TxopType >
TxopTests ChannelAccessManagerTest< TxopType >::m_txop
private

the vector of Txop test instances

Definition at line 394 of file channel-access-manager-test.cc.


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