mesh-wifi-interface-mac.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2009 IITP RAS
 *
 * 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
 *
 * Authors: Kirill Andreev <andreev@iitp.ru>
 *          Pavel Boyko <boyko@iitp.ru>
 */

#ifndef MESH_WIFI_INTERFACE_MAC_H
#define MESH_WIFI_INTERFACE_MAC_H

#include <stdint.h>
#include <map>
#include "ns3/mac48-address.h"
#include "ns3/mgt-headers.h"
#include "ns3/callback.h"
#include "ns3/packet.h"
#include "ns3/nstime.h"
#include "ns3/wifi-remote-station-manager.h"
#include "ns3/regular-wifi-mac.h"
#include "ns3/mesh-wifi-interface-mac-plugin.h"
#include "ns3/event-id.h"
#include "qos-utils.h"

namespace ns3 {

class WifiMacHeader;
class DcaTxop;
class UniformRandomVariable;
class MeshWifiInterfaceMac : public RegularWifiMac
{
public:
  static TypeId GetTypeId ();
  MeshWifiInterfaceMac ();
  virtual ~MeshWifiInterfaceMac ();

  // \{
  virtual void  Enqueue (Ptr<const Packet> packet, Mac48Address to, Mac48Address from);
  virtual void  Enqueue (Ptr<const Packet> packet, Mac48Address to);
  virtual bool  SupportsSendFrom () const;
  virtual void  SetLinkUpCallback (Callback<void> linkUp);
  // \}
  // \{
  void SetMeshPointAddress (Mac48Address);
  Mac48Address GetMeshPointAddress () const;
  // \}
  // \{
  void SetRandomStartDelay (Time interval);
  void SetBeaconInterval (Time interval);
  Time GetBeaconInterval () const;
  Time GetTbtt () const;
  void ShiftTbtt (Time shift);
  // \}

  // \{
  void InstallPlugin (Ptr<MeshWifiInterfaceMacPlugin> plugin);
  // \}

  // \{
  uint16_t GetFrequencyChannel () const;
  void SwitchFrequencyChannel (uint16_t new_id);
  // \}

  void SendManagementFrame (Ptr<Packet> frame, const WifiMacHeader& hdr);
  bool CheckSupportedRates (SupportedRates rates) const;
  SupportedRates GetSupportedRates () const;
  // \{
  void SetLinkMetricCallback (Callback<uint32_t, Mac48Address, Ptr<MeshWifiInterfaceMac> > cb);
  uint32_t GetLinkMetric (Mac48Address peerAddress);
  // \}
  void Report (std::ostream &) const;
  void ResetStats ();
  void SetBeaconGeneration (bool enable);
  WifiPhyStandard GetPhyStandard () const;
  virtual void FinishConfigureStandard (enum WifiPhyStandard standard);
  int64_t AssignStreams (int64_t stream);
private:
  void  Receive (Ptr<Packet> packet, WifiMacHeader const *hdr);
  void  ForwardDown (Ptr<const Packet> packet, Mac48Address from, Mac48Address to);
  void SendBeacon ();
  void ScheduleNextBeacon ();
  bool GetBeaconGeneration () const;
  virtual void DoDispose ();

private:
  typedef std::vector<Ptr<MeshWifiInterfaceMacPlugin> > PluginList;

  virtual void DoInitialize ();

  // \{
  bool m_beaconEnable;
  Time m_beaconInterval;
  Time m_randomStart;
  Time m_tbtt;
  // \}

  Mac48Address m_mpAddress;

  EventId m_beaconSendEvent;
  PluginList m_plugins;
  Callback<uint32_t, Mac48Address, Ptr<MeshWifiInterfaceMac> > m_linkMetricCallback;
  // \{
  struct Statistics
  {
    uint16_t recvBeacons;
    uint32_t sentFrames;
    uint32_t sentBytes;
    uint32_t recvFrames;
    uint32_t recvBytes;
    void
    Print (std::ostream & os) const;
    Statistics ();
  };
  Statistics m_stats;
  // \}
  WifiPhyStandard m_standard;

  Ptr<UniformRandomVariable> m_coefficient;
};

} // namespace ns3

#endif /* MESH_WIFI_INTERFACE_MAC_H */