wifi-tx-timer.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2020 Universita' degli Studi di Napoli Federico II
 *
 * 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: Stefano Avallone <stavallo@unina.it>
 */
 
#ifndef WIFI_TX_TIMER_H
#define WIFI_TX_TIMER_H
 
#include "ns3/event-id.h"
#include "ns3/nstime.h"
#include "ns3/simulator.h"
#include "ns3/traced-callback.h"
#include <functional>
#include <unordered_map>
 
namespace ns3 {
 
class WifiMacQueueItem;
class WifiPsdu;
class WifiTxVector;
class Mac48Address;
 
typedef std::unordered_map <uint16_t /* staId */, Ptr<WifiPsdu> /* PSDU */> WifiPsduMap;
 
class WifiTxTimer
{
public:
  enum Reason : uint8_t
    {
      NOT_RUNNING = 0,
      WAIT_CTS,
      WAIT_NORMAL_ACK,
      WAIT_BLOCK_ACK,
      WAIT_NORMAL_ACK_AFTER_DL_MU_PPDU,
      WAIT_BLOCK_ACKS_IN_TB_PPDU,
      WAIT_TB_PPDU_AFTER_BASIC_TF,
      WAIT_QOS_NULL_AFTER_BSRP_TF,
      WAIT_BLOCK_ACK_AFTER_TB_PPDU,
    };
 
  WifiTxTimer ();
 
  virtual ~WifiTxTimer ();
 
  template<typename MEM, typename OBJ, typename... Args>
  void Set (Reason reason, const Time &delay, MEM mem_ptr, OBJ obj, Args... args);
 
  void Reschedule (const Time &delay);
 
  Reason GetReason (void) const;
 
  std::string GetReasonString (Reason reason) const;
 
  bool IsRunning (void) const;
 
  void Cancel (void);
 
  Time GetDelayLeft (void) const;
 
  typedef Callback<void, uint8_t, Ptr<const WifiMacQueueItem>, const WifiTxVector&> MpduResponseTimeout;
 
  typedef Callback<void, uint8_t, Ptr<const WifiPsdu>, const WifiTxVector&> PsduResponseTimeout;
 
  typedef Callback<void, uint8_t, WifiPsduMap*, const std::set<Mac48Address>*, std::size_t> PsduMapResponseTimeout;
 
  void SetMpduResponseTimeoutCallback (MpduResponseTimeout callback) const;
 
  void SetPsduResponseTimeoutCallback (PsduResponseTimeout callback) const;
 
  void SetPsduMapResponseTimeoutCallback (PsduMapResponseTimeout callback) const;
 
private:
  template<typename MEM, typename OBJ, typename... Args>
  void Timeout (MEM mem_ptr, OBJ obj, Args... args);
 
  void Expire (void);
 
  void FeedTraceSource (Ptr<WifiMacQueueItem> item, WifiTxVector txVector);
 
  void FeedTraceSource (Ptr<WifiPsdu> psdu, WifiTxVector txVector);
 
  void FeedTraceSource (WifiPsduMap* psduMap, std::set<Mac48Address>* missingStations,
                        std::size_t nTotalStations);
 
  EventId m_timeoutEvent;         
  Reason m_reason;                
  Ptr<EventImpl> m_impl;          
  Time m_end;                     
 
  mutable MpduResponseTimeout m_mpduResponseTimeoutCallback;
  mutable PsduResponseTimeout m_psduResponseTimeoutCallback;
  mutable PsduMapResponseTimeout m_psduMapResponseTimeoutCallback;
};
 
} // namespace ns3
 
 
/***************************************************************
 *  Implementation of the templates declared above.
 ***************************************************************/
 
namespace ns3 {
 
template<typename MEM, typename OBJ, typename... Args>
void
WifiTxTimer::Set (Reason reason, const Time &delay, MEM mem_ptr, OBJ obj, Args... args)
{
  typedef void (WifiTxTimer::*TimeoutType)(MEM, OBJ, Args...);
 
  m_timeoutEvent = Simulator::Schedule (delay, &WifiTxTimer::Expire, this);
  m_reason = reason;
  m_end = Simulator::Now () + delay;
 
  // create an event to invoke when the timer expires
  m_impl = Ptr<EventImpl> (MakeEvent<TimeoutType> (&WifiTxTimer::Timeout, this, mem_ptr, obj,
                                                   std::forward<Args> (args)... ), false);
}
 
template<typename MEM, typename OBJ, typename... Args>
void
WifiTxTimer::Timeout (MEM mem_ptr, OBJ obj, Args... args)
{
  FeedTraceSource (std::forward<Args> (args)...);
 
  // Invoke the method set by the user
  ((*obj).*mem_ptr)(std::forward<Args> (args)...);
}
 
} //namespace ns3
 
#endif /* WIFI_TX_TIMER_H */