src/devices/wifi/onoe-wifi-manager.h
author Quincy Tse <quincy.tse@gmail.com>
Mon, 07 Jun 2010 16:22:21 +0200
changeset 6340 fe24c9edacb6
parent 6339 84cbcc1a3f16
permissions -rw-r--r--
fixed bug 924
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     1
/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     2
/*
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     3
 * Copyright (c) 2003,2007 INRIA
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     4
 *
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as 
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     8
 *
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    12
 * GNU General Public License for more details.
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    13
 *
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    17
 *
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    18
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    19
 */
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    20
#ifndef ONOE_WIFI_MANAGER_H
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    21
#define ONOE_WIFI_MANAGER_H
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    22
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    23
#include "wifi-remote-station-manager.h"
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    24
#include "ns3/nstime.h"
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    25
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    26
namespace ns3 {
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    27
6340
fe24c9edacb6 fixed bug 924
Quincy Tse <quincy.tse@gmail.com>
parents: 6339
diff changeset
    28
struct OnoeWifiRemoteStation;
6065
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    29
2962
39f72ca0ba8e improve doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2784
diff changeset
    30
/**
39f72ca0ba8e improve doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2784
diff changeset
    31
 * \brief an implementation of rate control algorithm developed 
39f72ca0ba8e improve doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2784
diff changeset
    32
 *        by Atsushi Onoe
39f72ca0ba8e improve doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2784
diff changeset
    33
 *
39f72ca0ba8e improve doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2784
diff changeset
    34
 * This algorithm is well known because it has been used as the default
39f72ca0ba8e improve doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2784
diff changeset
    35
 * rate control algorithm for the madwifi driver. I am not aware of
39f72ca0ba8e improve doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2784
diff changeset
    36
 * any publication or reference about this algorithm beyond the madwifi
39f72ca0ba8e improve doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2784
diff changeset
    37
 * source code.
39f72ca0ba8e improve doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2784
diff changeset
    38
 */
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    39
class OnoeWifiManager : public WifiRemoteStationManager
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    40
{
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    41
public:
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    42
  static TypeId GetTypeId (void);
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    43
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    44
  OnoeWifiManager ();
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    45
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    46
private:
6065
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    47
  // overriden from base class
6339
84cbcc1a3f16 fixed bug 922
Nicola Baldo <nbaldo@cttc.es>
parents: 6065
diff changeset
    48
  virtual WifiRemoteStation *DoCreateStation (void) const;
6065
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    49
  virtual void DoReportRxOk (WifiRemoteStation *station, 
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    50
                             double rxSnr, WifiMode txMode);
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    51
  virtual void DoReportRtsFailed (WifiRemoteStation *station);
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    52
  virtual void DoReportDataFailed (WifiRemoteStation *station);
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    53
  virtual void DoReportRtsOk (WifiRemoteStation *station,
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    54
                              double ctsSnr, WifiMode ctsMode, double rtsSnr);
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    55
  virtual void DoReportDataOk (WifiRemoteStation *station,
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    56
                               double ackSnr, WifiMode ackMode, double dataSnr);
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    57
  virtual void DoReportFinalRtsFailed (WifiRemoteStation *station);
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    58
  virtual void DoReportFinalDataFailed (WifiRemoteStation *station);
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    59
  virtual WifiMode DoGetDataMode (WifiRemoteStation *station, uint32_t size);
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    60
  virtual WifiMode DoGetRtsMode (WifiRemoteStation *station);
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    61
  virtual bool IsLowLatency (void) const;
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    62
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    63
  void UpdateRetry (OnoeWifiRemoteStation *station);
0f012e7d9128 bug 602
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2962
diff changeset
    64
  void UpdateMode (OnoeWifiRemoteStation *station);
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    65
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    66
  Time m_updatePeriod;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    67
  uint32_t m_addCreditThreshold;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    68
  uint32_t m_raiseThreshold;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    69
};
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    70
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    71
} // namespace ns3
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    72
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    73
#endif /* ONOE_WIFI_MANAGER_H */