A Discrete-Event Network Simulator
API
TestPhyListener Class Reference
+ Inheritance diagram for TestPhyListener:
+ Collaboration diagram for TestPhyListener:

Public Member Functions

 TestPhyListener (void)
 Create a test PhyListener. More...
 
virtual ~TestPhyListener ()
 
virtual void NotifyMaybeCcaBusyStart (Time duration)
 
virtual void NotifyRxEndError (void)
 We have received the last bit of a packet for which NotifyRxStart was invoked first and, the packet has not been successfully received. More...
 
virtual void NotifyRxEndOk (void)
 We have received the last bit of a packet for which NotifyRxStart was invoked first and, the packet has been successfully received. More...
 
virtual void NotifyRxStart (Time duration)
 
virtual void NotifySleep (void)
 Notify listeners that we went to sleep. More...
 
virtual void NotifySwitchingStart (Time duration)
 
virtual void NotifyTxStart (Time duration, double txPowerDbm)
 
virtual void NotifyWakeup (void)
 Notify listeners that we woke up. More...
 
- Public Member Functions inherited from ns3::WifiPhyListener
virtual ~WifiPhyListener ()
 

Public Attributes

uint32_t m_notifyMaybeCcaBusyStart
 
uint32_t m_notifyRxEndError
 
uint32_t m_notifyRxEndOk
 
uint32_t m_notifyRxStart
 

Detailed Description

Definition at line 153 of file spectrum-wifi-phy-test.cc.

Constructor & Destructor Documentation

TestPhyListener::TestPhyListener ( void  )
inline

Create a test PhyListener.

Definition at line 160 of file spectrum-wifi-phy-test.cc.

virtual TestPhyListener::~TestPhyListener ( )
inlinevirtual

Definition at line 167 of file spectrum-wifi-phy-test.cc.

Member Function Documentation

virtual void TestPhyListener::NotifyMaybeCcaBusyStart ( Time  duration)
inlinevirtual
Parameters
durationthe expected busy duration.

This method does not really report a real state change as opposed to the other methods in this class. It merely reports that, unless the medium is reported busy through NotifyTxStart or NotifyRxStart/End, it will be busy as defined by the currently selected CCA mode.

Typical client code which wants to have a clear picture of the CCA state will need to keep track of the time at which the last NotifyCcaBusyStart method is called and what duration it reported.

Implements ns3::WifiPhyListener.

Definition at line 185 of file spectrum-wifi-phy-test.cc.

References m_notifyMaybeCcaBusyStart.

virtual void TestPhyListener::NotifyRxEndError ( void  )
inlinevirtual

We have received the last bit of a packet for which NotifyRxStart was invoked first and, the packet has not been successfully received.

Implements ns3::WifiPhyListener.

Definition at line 178 of file spectrum-wifi-phy-test.cc.

References m_notifyRxEndError.

virtual void TestPhyListener::NotifyRxEndOk ( void  )
inlinevirtual

We have received the last bit of a packet for which NotifyRxStart was invoked first and, the packet has been successfully received.

Implements ns3::WifiPhyListener.

Definition at line 174 of file spectrum-wifi-phy-test.cc.

References m_notifyRxEndOk.

virtual void TestPhyListener::NotifyRxStart ( Time  duration)
inlinevirtual
Parameters
durationthe expected duration of the packet reception.

We have received the first bit of a packet. We decided that we could synchronize on this packet. It does not mean we will be able to successfully receive completely the whole packet. It means that we will report a BUSY status until one of the following happens:

  • NotifyRxEndOk
  • NotifyRxEndError
  • NotifyTxStart

Implements ns3::WifiPhyListener.

Definition at line 170 of file spectrum-wifi-phy-test.cc.

References m_notifyRxStart.

virtual void TestPhyListener::NotifySleep ( void  )
inlinevirtual

Notify listeners that we went to sleep.

Implements ns3::WifiPhyListener.

Definition at line 192 of file spectrum-wifi-phy-test.cc.

virtual void TestPhyListener::NotifySwitchingStart ( Time  duration)
inlinevirtual
Parameters
durationthe expected channel switching duration.

We do not send any event to notify the end of channel switching. Listeners should assume that the channel implicitely reverts to the idle or busy states.

Implements ns3::WifiPhyListener.

Definition at line 189 of file spectrum-wifi-phy-test.cc.

virtual void TestPhyListener::NotifyTxStart ( Time  duration,
double  txPowerDbm 
)
inlinevirtual
Parameters
durationthe expected transmission duration.
txPowerDbmthe nominal tx power in dBm

We are about to send the first bit of the packet. We do not send any event to notify the end of transmission. Listeners should assume that the channel implicitely reverts to the idle state unless they have received a cca busy report.

Implements ns3::WifiPhyListener.

Definition at line 182 of file spectrum-wifi-phy-test.cc.

virtual void TestPhyListener::NotifyWakeup ( void  )
inlinevirtual

Notify listeners that we woke up.

Implements ns3::WifiPhyListener.

Definition at line 195 of file spectrum-wifi-phy-test.cc.

Member Data Documentation

uint32_t TestPhyListener::m_notifyMaybeCcaBusyStart
uint32_t TestPhyListener::m_notifyRxEndError

Definition at line 200 of file spectrum-wifi-phy-test.cc.

Referenced by NotifyRxEndError().

uint32_t TestPhyListener::m_notifyRxEndOk

Definition at line 199 of file spectrum-wifi-phy-test.cc.

Referenced by SpectrumWifiPhyListenerTest::DoRun(), and NotifyRxEndOk().

uint32_t TestPhyListener::m_notifyRxStart

Definition at line 198 of file spectrum-wifi-phy-test.cc.

Referenced by SpectrumWifiPhyListenerTest::DoRun(), and NotifyRxStart().


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