Public Member Functions

ns3::WifiPhyListener Class Reference

receive notifications about phy events. More...

#include <wifi-phy.h>

List of all members.

Public Member Functions

virtual void NotifyRxStart (Time duration)=0
virtual void NotifyRxEndOk (void)=0
virtual void NotifyRxEndError (void)=0
virtual void NotifyTxStart (Time duration)=0
virtual void NotifyMaybeCcaBusyStart (Time duration)=0
virtual void NotifySwitchingStart (Time duration)=0

Detailed Description

receive notifications about phy events.


Member Function Documentation

virtual void ns3::WifiPhyListener::NotifyMaybeCcaBusyStart ( Time  duration  )  [pure virtual]
Parameters:
duration the 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.

virtual void ns3::WifiPhyListener::NotifyRxEndError ( void   )  [pure virtual]

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

virtual void ns3::WifiPhyListener::NotifyRxEndOk ( void   )  [pure virtual]

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

virtual void ns3::WifiPhyListener::NotifyRxStart ( Time  duration  )  [pure virtual]
Parameters:
duration the 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
  • NotifyExEndError
  • NotifyTxStart
virtual void ns3::WifiPhyListener::NotifySwitchingStart ( Time  duration  )  [pure virtual]
Parameters:
duration the 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.

virtual void ns3::WifiPhyListener::NotifyTxStart ( Time  duration  )  [pure virtual]
Parameters:
duration the expected transmission duration.

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.


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