A Discrete-Event Network Simulator
API
wifi-phy-state-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005,2006 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #ifndef WIFI_PHY_STATE_HELPER_H
22 #define WIFI_PHY_STATE_HELPER_H
23 
24 #include "ns3/object.h"
25 #include "ns3/callback.h"
26 #include "ns3/traced-callback.h"
27 #include "ns3/nstime.h"
28 #include "wifi-phy-state.h"
29 #include "wifi-preamble.h"
30 
31 namespace ns3 {
32 
33 class WifiPhyListener;
34 class WifiTxVector;
35 class WifiMode;
36 class Packet;
37 class WifiPsdu;
38 
49 typedef Callback<void, Ptr<WifiPsdu>, double, WifiTxVector, std::vector<bool>> RxOkCallback;
56 
62 class WifiPhyStateHelper : public Object
63 {
64 public:
69  static TypeId GetTypeId (void);
70 
72 
78  void SetReceiveOkCallback (RxOkCallback callback);
90  void RegisterListener (WifiPhyListener *listener);
96  void UnregisterListener (WifiPhyListener *listener);
102  WifiPhyState GetState (void) const;
108  bool IsStateCcaBusy (void) const;
114  bool IsStateIdle (void) const;
120  bool IsStateRx (void) const;
126  bool IsStateTx (void) const;
132  bool IsStateSwitching (void) const;
138  bool IsStateSleep (void) const;
144  bool IsStateOff (void) const;
150  Time GetDelayUntilIdle (void) const;
156  Time GetLastRxStartTime (void) const;
157 
166  void SwitchToTx (Time txDuration, Ptr<const Packet> packet, double txPowerDbm, WifiTxVector txVector);
172  void SwitchToRx (Time rxDuration);
178  void SwitchToChannelSwitching (Time switchingDuration);
187  void SwitchFromRxEndOk (Ptr<WifiPsdu> psdu, double snr, WifiTxVector txVector, std::vector<bool> statusPerMpdu);
194  void SwitchFromRxEndError (Ptr<WifiPsdu> psdu, double snr);
200  void SwitchMaybeToCcaBusy (Time duration);
204  void SwitchToSleep (void);
210  void SwitchFromSleep (Time duration);
216  void SwitchFromRxAbort (bool failure);
220  void SwitchToOff (void);
226  void SwitchFromOff (Time duration);
227 
236  typedef void (* StateTracedCallback)(Time start, Time duration, WifiPhyState state);
237 
246  typedef void (* RxOkTracedCallback)(Ptr<const Packet> packet, double snr, WifiMode mode, WifiPreamble preamble);
247 
254  typedef void (* RxEndErrorTracedCallback)(Ptr<const Packet> packet, double snr);
255 
264  typedef void (* TxTracedCallback)(Ptr<const Packet> packet, WifiMode mode,
265  WifiPreamble preamble, uint8_t power);
266 
267 
268 private:
272  typedef std::vector<WifiPhyListener *> Listeners;
276  typedef std::vector<WifiPhyListener *>::iterator ListenersI;
277 
282 
289  void NotifyTxStart (Time duration, double txPowerDbm);
295  void NotifyRxStart (Time duration);
299  void NotifyRxEndOk (void);
303  void NotifyRxEndError (void);
309  void NotifyMaybeCcaBusyStart (Time duration);
316  void NotifySwitchingStart (Time duration);
320  void NotifySleep (void);
324  void NotifyOff (void);
328  void NotifyWakeup (void);
332  void DoSwitchFromRx (void);
336  void NotifyOn (void);
337 
342 
343  bool m_sleeping;
344  bool m_isOff;
355 
362 };
363 
364 } //namespace ns3
365 
366 #endif /* WIFI_PHY_STATE_HELPER_H */
bool IsStateIdle(void) const
Check whether the current state is IDLE.
Time GetLastRxStartTime(void) const
Return the time the last RX start.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
void DoSwitchFromRx(void)
Switch the state from RX.
Callback template class.
Definition: callback.h:1176
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
TracedCallback< Time, Time, WifiPhyState > m_stateLogger
The trace source fired when state is changed.
void NotifyWakeup(void)
Notify all WifiPhyListener that we woke up.
Time m_endCcaBusy
endn CCA busy
def start()
Definition: core.py:1855
Forward calls to a chain of Callback.
void(* StateTracedCallback)(Time start, Time duration, WifiPhyState state)
TracedCallback signature for state changes.
Time m_startCcaBusy
start CCA busy
void SwitchToOff(void)
Switch to off mode.
void SwitchToChannelSwitching(Time switchingDuration)
Switch state to channel switching for the given duration.
void UnregisterListener(WifiPhyListener *listener)
Remove WifiPhyListener from this WifiPhyStateHelper.
void NotifyRxEndError(void)
Notify all WifiPhyListener that the reception was not successful.
std::vector< WifiPhyListener * >::iterator ListenersI
typedef for a list of WifiPhyListeners iterator
bool IsStateRx(void) const
Check whether the current state is RX.
represent a single transmission modeA WifiMode is implemented by a single integer which is used to lo...
Definition: wifi-mode.h:97
bool IsStateSwitching(void) const
Check whether the current state is SWITCHING.
void SwitchFromSleep(Time duration)
Switch from sleep mode.
Time GetDelayUntilIdle(void) const
Return the time before the state is back to IDLE.
Callback< void, Ptr< WifiPsdu >, double, WifiTxVector, std::vector< bool > > RxOkCallback
Callback if PSDU successfully received (i.e.
std::vector< WifiPhyListener * > Listeners
typedef for a list of WifiPhyListeners
WifiPreamble
The type of preamble to be used by an IEEE 802.11 transmission.
Definition: wifi-preamble.h:32
void NotifySleep(void)
Notify all WifiPhyListener that we are going to sleep.
Time m_endSwitching
end switching
bool IsStateSleep(void) const
Check whether the current state is SLEEP.
void NotifyOn(void)
Notify all WifiPhyListener that we are going to switch on.
void(* RxOkTracedCallback)(Ptr< const Packet > packet, double snr, WifiMode mode, WifiPreamble preamble)
TracedCallback signature for receive end ok event.
receive notifications about phy events.
void NotifySwitchingStart(Time duration)
Notify all WifiPhyListener that we are switching channel with the given channel switching delay...
Time m_previousStateChangeTime
previous state change time
void(* TxTracedCallback)(Ptr< const Packet > packet, WifiMode mode, WifiPreamble preamble, uint8_t power)
TracedCallback signature for transmit event.
TracedCallback< Ptr< const Packet >, double, WifiMode, WifiPreamble > m_rxOkTrace
receive OK trace callback
void NotifyMaybeCcaBusyStart(Time duration)
Notify all WifiPhyListener that the CCA has started for the given duration.
RxErrorCallback m_rxErrorCallback
receive error callback
bool IsStateTx(void) const
Check whether the current state is TX.
void SwitchToTx(Time txDuration, Ptr< const Packet > packet, double txPowerDbm, WifiTxVector txVector)
Switch state to TX for the given duration.
WifiPsdu stores an MPDU, S-MPDU or A-MPDU, by keeping header(s) and payload(s) separate for each cons...
Definition: wifi-psdu.h:40
void SwitchToSleep(void)
Switch to sleep mode.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
WifiPhyState
The state of the PHY layer.
Time m_startSwitching
start switching
void SetReceiveOkCallback(RxOkCallback callback)
Set a callback for a successful reception.
void SwitchFromRxAbort(bool failure)
Abort current reception.
Time m_startTx
start transmit
void NotifyTxStart(Time duration, double txPowerDbm)
Notify all WifiPhyListener that the transmission has started for the given duration.
void NotifyRxEndOk(void)
Notify all WifiPhyListener that the reception was successful.
void SwitchFromRxEndError(Ptr< WifiPsdu > psdu, double snr)
Switch from RX after the reception failed.
TracedCallback< Ptr< const Packet >, WifiMode, WifiPreamble, uint8_t > m_txTrace
transmit trace callback
static TypeId GetTypeId(void)
Get the type ID.
This objects implements the PHY state machine of the Wifi device.
WifiPhyState GetState(void) const
Return the current state of WifiPhy.
void SwitchFromOff(Time duration)
Switch from off mode.
Listeners m_listeners
listeners
Callback< void, Ptr< WifiPsdu > > RxErrorCallback
Callback if PSDU unsuccessfully received.
bool IsStateOff(void) const
Check whether the current state is OFF.
void SetReceiveErrorCallback(RxErrorCallback callback)
Set a callback for a failed reception.
void(* RxEndErrorTracedCallback)(Ptr< const Packet > packet, double snr)
TracedCallback signature for receive end error event.
TracedCallback< Ptr< const Packet >, double > m_rxErrorTrace
receive error trace callback
void SwitchFromRxEndOk(Ptr< WifiPsdu > psdu, double snr, WifiTxVector txVector, std::vector< bool > statusPerMpdu)
Switch from RX after the reception was successful.
A base class which provides memory management and object aggregation.
Definition: object.h:87
void SwitchToRx(Time rxDuration)
Switch state to RX for the given duration.
void LogPreviousIdleAndCcaBusyStates(void)
Log the ideal and CCA states.
void NotifyRxStart(Time duration)
Notify all WifiPhyListener that the reception has started for the given duration. ...
a unique identifier for an interface.
Definition: type-id.h:58
void RegisterListener(WifiPhyListener *listener)
Register WifiPhyListener to this WifiPhyStateHelper.
void SwitchMaybeToCcaBusy(Time duration)
Switch to CCA busy.
RxOkCallback m_rxOkCallback
receive OK callback
void NotifyOff(void)
Notify all WifiPhyListener that we are going to switch off.
bool IsStateCcaBusy(void) const
Check whether the current state is CCA busy.