wifi-phy-state-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2005,2006 INRIA
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */

#ifndef WIFI_PHY_STATE_HELPER_H
#define WIFI_PHY_STATE_HELPER_H

#include "ns3/object.h"
#include "ns3/callback.h"
#include "ns3/traced-callback.h"
#include "ns3/nstime.h"
#include "wifi-phy-state.h"
#include "wifi-preamble.h"

namespace ns3 {

class WifiPhyListener;
class WifiTxVector;
class WifiMode;
class Packet;

typedef Callback<void, Ptr<Packet>, double, WifiTxVector, std::vector<bool>> RxOkCallback;
typedef Callback<void, Ptr<Packet>> RxErrorCallback;

class WifiPhyStateHelper : public Object
{
public:
  static TypeId GetTypeId (void);

  WifiPhyStateHelper ();

  void SetReceiveOkCallback (RxOkCallback callback);
  void SetReceiveErrorCallback (RxErrorCallback callback);
  void RegisterListener (WifiPhyListener *listener);
  void UnregisterListener (WifiPhyListener *listener);
  WifiPhyState GetState (void) const;
  bool IsStateCcaBusy (void) const;
  bool IsStateIdle (void) const;
  bool IsStateRx (void) const;
  bool IsStateTx (void) const;
  bool IsStateSwitching (void) const;
  bool IsStateSleep (void) const;
  bool IsStateOff (void) const;
  Time GetDelayUntilIdle (void) const;
  Time GetLastRxStartTime (void) const;

  void SwitchToTx (Time txDuration, Ptr<const Packet> packet, double txPowerDbm, WifiTxVector txVector);
  void SwitchToRx (Time rxDuration);
  void SwitchToChannelSwitching (Time switchingDuration);
  void SwitchFromRxEndOk (Ptr<Packet> packet, double snr, WifiTxVector txVector, std::vector<bool> statusPerMpdu);
  void SwitchFromRxEndError (Ptr<Packet> packet, double snr);
  void SwitchMaybeToCcaBusy (Time duration);
  void SwitchToSleep (void);
  void SwitchFromSleep (Time duration);
  void SwitchFromRxAbort (bool failure);
  void SwitchToOff (void);
  void SwitchFromOff (Time duration);

  typedef void (* StateTracedCallback)(Time start, Time duration, WifiPhyState state);

  typedef void (* RxOkTracedCallback)(Ptr<const Packet> packet, double snr, WifiMode mode, WifiPreamble preamble);

  typedef void (* RxEndErrorTracedCallback)(Ptr<const Packet> packet, double snr);

  typedef void (* TxTracedCallback)(Ptr<const Packet> packet, WifiMode mode,
                                    WifiPreamble preamble, uint8_t power);


private:
  typedef std::vector<WifiPhyListener *> Listeners;
  typedef std::vector<WifiPhyListener *>::iterator ListenersI;

  void LogPreviousIdleAndCcaBusyStates (void);

  void NotifyTxStart (Time duration, double txPowerDbm);
  void NotifyRxStart (Time duration);
  void NotifyRxEndOk (void);
  void NotifyRxEndError (void);
  void NotifyMaybeCcaBusyStart (Time duration);
  void NotifySwitchingStart (Time duration);
  void NotifySleep (void);
  void NotifyOff (void);
  void NotifyWakeup (void);
  void DoSwitchFromRx (void);
  void NotifyOn (void);

  TracedCallback<Time, Time, WifiPhyState> m_stateLogger;

  bool m_sleeping; 
  bool m_isOff; 
  Time m_endTx; 
  Time m_endRx; 
  Time m_endCcaBusy; 
  Time m_endSwitching; 
  Time m_startTx; 
  Time m_startRx; 
  Time m_startCcaBusy; 
  Time m_startSwitching; 
  Time m_startSleep; 
  Time m_previousStateChangeTime; 

  Listeners m_listeners; 
  TracedCallback<Ptr<const Packet>, double, WifiMode, WifiPreamble> m_rxOkTrace; 
  TracedCallback<Ptr<const Packet>, double> m_rxErrorTrace; 
  TracedCallback<Ptr<const Packet>, WifiMode, WifiPreamble, uint8_t> m_txTrace; 
  RxOkCallback m_rxOkCallback; 
  RxErrorCallback m_rxErrorCallback; 
};

} //namespace ns3

#endif /* WIFI_PHY_STATE_HELPER_H */