src/devices/wifi/arf-mac-stations.h
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Wed, 31 Oct 2007 16:26:31 +0100
changeset 2059 d8b7b2de044e
parent 2005 c15d40b835b5
child 2268 0e57ac711220
permissions -rw-r--r--
doxygen
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     1
/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     2
/*
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     3
 * Copyright (c) 2005,2006 INRIA
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     4
 *
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as 
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     8
 *
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    12
 * GNU General Public License for more details.
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    13
 *
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    17
 *
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    18
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    19
 */
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    20
#ifndef ARF_MAC_STATIONS_H
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    21
#define ARF_MAC_STATIONS_H
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    22
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    23
#include "mac-stations.h"
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    24
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    25
namespace ns3 {
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    26
2059
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    27
/**
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    28
 * \brief ARF Rate control algorithm
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    29
 *
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    30
 * This class implements the so-called ARF algorithm which was
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    31
 * initially described in <i>WaveLAN-II: A High-performance wireless 
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    32
 * LAN for the unlicensed band</i>, by A. Kamerman and L. Monteban. in
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    33
 * Bell Lab Technical Journal, pages 118-133, Summer 1997.
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    34
 *
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    35
 * This implementation differs from the initial description in that it
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    36
 * uses a packet-based timer rather than a time-based timer as described 
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    37
 * in XXX (I cannot find back the original paper which described how
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    38
 * the time-based timer could be easily replaced with a packet-based 
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    39
 * timer.)
d8b7b2de044e doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2005
diff changeset
    40
 */
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    41
class ArfMacStations : public MacStations {
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    42
public:
2004
59eb6fb7b722 control the rate control algorithms with default values.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1977
diff changeset
    43
  ArfMacStations (WifiMode defaultTxMode, uint32_t timerThreshold, uint32_t successThreshold);
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    44
  virtual ~ArfMacStations ();
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    45
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    46
private:
1930
ec22299cf6bb rework MacStations to handle correctly Supported vs Basic rate sets and add IdealMacStations to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1921
diff changeset
    47
  virtual class MacStation *CreateStation (void);
2004
59eb6fb7b722 control the rate control algorithms with default values.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1977
diff changeset
    48
  uint32_t m_timerThreshold;
59eb6fb7b722 control the rate control algorithms with default values.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1977
diff changeset
    49
  uint32_t m_successThreshold;
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    50
};
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    51
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    52
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    53
class ArfMacStation : public MacStation
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    54
{
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    55
public:
1930
ec22299cf6bb rework MacStations to handle correctly Supported vs Basic rate sets and add IdealMacStations to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1921
diff changeset
    56
  ArfMacStation (ArfMacStations *stations,
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    57
                 int minTimerTimeout,
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    58
                 int minSuccessThreshold);
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    59
  virtual ~ArfMacStation ();
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    60
1917
d781597e35c0 port ArfMacStations to new MacStation API
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1895
diff changeset
    61
  virtual void ReportRxOk (double rxSnr, WifiMode txMode);
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    62
  virtual void ReportRtsFailed (void);
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    63
  virtual void ReportDataFailed (void);
1917
d781597e35c0 port ArfMacStations to new MacStation API
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1895
diff changeset
    64
  virtual void ReportRtsOk (double ctsSnr, WifiMode ctsMode, double rtsSnr);
d781597e35c0 port ArfMacStations to new MacStation API
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1895
diff changeset
    65
  virtual void ReportDataOk (double ackSnr, WifiMode ackMode, double dataSnr);
d781597e35c0 port ArfMacStations to new MacStation API
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1895
diff changeset
    66
  virtual WifiMode GetDataMode (uint32_t size);
d781597e35c0 port ArfMacStations to new MacStation API
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1895
diff changeset
    67
  virtual WifiMode GetRtsMode (void);
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    68
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    69
private:
1930
ec22299cf6bb rework MacStations to handle correctly Supported vs Basic rate sets and add IdealMacStations to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1921
diff changeset
    70
  virtual ArfMacStations *GetStations (void) const;
ec22299cf6bb rework MacStations to handle correctly Supported vs Basic rate sets and add IdealMacStations to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1921
diff changeset
    71
2005
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
    72
  uint32_t m_timer;
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
    73
  uint32_t m_success;
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
    74
  uint32_t m_failed;
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    75
  bool m_recovery;
2005
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
    76
  uint32_t m_retry;
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    77
  
2005
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
    78
  uint32_t m_timerTimeout;
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
    79
  uint32_t m_successThreshold;
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    80
2005
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
    81
  uint32_t m_rate;
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    82
  
2005
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
    83
  uint32_t m_minTimerTimeout;
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
    84
  uint32_t m_minSuccessThreshold;
1930
ec22299cf6bb rework MacStations to handle correctly Supported vs Basic rate sets and add IdealMacStations to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1921
diff changeset
    85
ec22299cf6bb rework MacStations to handle correctly Supported vs Basic rate sets and add IdealMacStations to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1921
diff changeset
    86
  ArfMacStations *m_stations;
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    87
  
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    88
private:
1930
ec22299cf6bb rework MacStations to handle correctly Supported vs Basic rate sets and add IdealMacStations to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1921
diff changeset
    89
  // overriden by AarfMacStation.
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    90
  virtual void ReportRecoveryFailure (void);
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    91
  virtual void ReportFailure (void);
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    92
2005
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
    93
  uint32_t GetMaxRate (void);
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
    94
  uint32_t GetMinRate (void);
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    95
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    96
  bool NeedRecoveryFallback (void);
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    97
  bool NeedNormalFallback (void);
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    98
  
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    99
protected:
1930
ec22299cf6bb rework MacStations to handle correctly Supported vs Basic rate sets and add IdealMacStations to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1921
diff changeset
   100
  // called by AarfMacStation.
2005
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
   101
  uint32_t GetMinTimerTimeout (void);
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
   102
  uint32_t GetMinSuccessThreshold (void);
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   103
  
2005
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
   104
  uint32_t GetTimerTimeout (void);
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
   105
  uint32_t GetSuccessThreshold (void);
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   106
  
2005
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
   107
  void SetTimerTimeout (uint32_t timerTimeout);
c15d40b835b5 convert int to uint32_t
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2004
diff changeset
   108
  void SetSuccessThreshold (uint32_t successThreshold);
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   109
};
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   110
1977
4303409f3d8e remove uneeded trailing ';'
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1930
diff changeset
   111
} // namespace ns3
1895
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   112
6c2d6a5631bc add more files to build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   113
#endif /* ARF_MAC_STATIONS_H */