wifi-phy-state-helper.h

Go to the documentation of this file.

/*
 * 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 "wifi-phy-common.h"
#include "wifi-phy-state.h"
#include "wifi-ppdu.h"
 
#include "ns3/callback.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/traced-callback.h"
 
#include <list>
#include <memory>
#include <vector>
 
namespace ns3
{
 
class WifiPhyListener;
class WifiTxVector;
class WifiMode;
class Packet;
class WifiPsdu;
struct RxSignalInfo;
 
typedef Callback<void, Ptr<const WifiPsdu>, RxSignalInfo, WifiTxVector, std::vector<bool>>
    RxOkCallback;
typedef Callback<void, Ptr<const WifiPsdu>> RxErrorCallback;
 
class WifiPhyStateHelper : public Object
{
  public:
    static TypeId GetTypeId();
 
    WifiPhyStateHelper();
 
    void SetReceiveOkCallback(RxOkCallback callback);
    void SetReceiveErrorCallback(RxErrorCallback callback);
    void RegisterListener(const std::shared_ptr<WifiPhyListener>& listener);
    void UnregisterListener(const std::shared_ptr<WifiPhyListener>& listener);
    WifiPhyState GetState() const;
    bool IsStateCcaBusy() const;
    bool IsStateIdle() const;
    bool IsStateRx() const;
    bool IsStateTx() const;
    bool IsStateSwitching() const;
    bool IsStateSleep() const;
    bool IsStateOff() const;
    Time GetDelayUntilIdle() const;
    Time GetLastRxStartTime() const;
    Time GetLastRxEndTime() const;
 
    void SwitchToTx(Time txDuration,
                    WifiConstPsduMap psdus,
                    double txPowerDbm,
                    const WifiTxVector& txVector);
    void SwitchToRx(Time rxDuration);
    void SwitchToChannelSwitching(Time switchingDuration);
    void NotifyRxMpdu(Ptr<const WifiPsdu> psdu,
                      RxSignalInfo rxSignalInfo,
                      const WifiTxVector& txVector);
    void NotifyRxPsduSucceeded(Ptr<const WifiPsdu> psdu,
                               RxSignalInfo rxSignalInfo,
                               const WifiTxVector& txVector,
                               uint16_t staId,
                               const std::vector<bool>& statusPerMpdu);
    void NotifyRxPsduFailed(Ptr<const WifiPsdu> psdu, double snr);
    void SwitchFromRxEndOk();
    void SwitchFromRxEndError();
    void SwitchFromRxAbort(uint16_t operatingWidth);
    void SwitchMaybeToCcaBusy(Time duration,
                              WifiChannelListType channelType,
                              const std::vector<Time>& per20MhzDurations);
    void SwitchToSleep();
    void SwitchFromSleep();
    void SwitchToOff();
    void SwitchFromOff();
 
    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);
 
    template <typename FUNC, typename... Ts>
    void NotifyListeners(FUNC f, Ts&&... args);
 
  private:
    typedef std::list<std::weak_ptr<WifiPhyListener>> Listeners;
 
    void LogPreviousIdleAndCcaBusyStates();
 
    void DoSwitchFromRx();
 
    TracedCallback<Time, Time, WifiPhyState> m_stateLogger;
 
    NS_LOG_TEMPLATE_DECLARE;        
    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
 
/***************************************************************
 *  Implementation of the templates declared above.
 ***************************************************************/
 
namespace ns3
{
 
template <typename FUNC, typename... Ts>
void
WifiPhyStateHelper::NotifyListeners(FUNC f, Ts&&... args)
{
    NS_LOG_FUNCTION(this);
    // In some cases (e.g., when notifying an EMLSR client of a link switch), a notification
    // to a PHY listener involves the addition and/or removal of a PHY listener, thus modifying
    // the list we are iterating over. This is dangerous, so ensure that we iterate over a copy
    // of the list of PHY listeners. The copied list contains shared pointers to the PHY listeners
    // to prevent them from being deleted.
    std::list<std::shared_ptr<WifiPhyListener>> listeners;
    std::transform(m_listeners.cbegin(),
                   m_listeners.cend(),
                   std::back_inserter(listeners),
                   [](auto&& listener) { return listener.lock(); });
 
    for (const auto& listener : listeners)
    {
        if (listener)
        {
            std::invoke(f, listener, std::forward<Ts>(args)...);
        }
    }
}
 
} // namespace ns3
 
#endif /* WIFI_PHY_STATE_HELPER_H */