A Discrete-Event Network Simulator
API
mesh-wifi-interface-mac.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 IITP RAS
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Authors: Kirill Andreev <andreev@iitp.ru>
19  * Pavel Boyko <boyko@iitp.ru>
20  */
21 
22 #ifndef MESH_WIFI_INTERFACE_MAC_H
23 #define MESH_WIFI_INTERFACE_MAC_H
24 
25 #include <stdint.h>
26 #include <map>
27 #include "ns3/mac48-address.h"
28 #include "ns3/mgt-headers.h"
29 #include "ns3/callback.h"
30 #include "ns3/packet.h"
31 #include "ns3/nstime.h"
32 #include "ns3/regular-wifi-mac.h"
33 #include "ns3/mesh-wifi-interface-mac-plugin.h"
34 #include "ns3/event-id.h"
35 
36 namespace ns3 {
37 
38 class UniformRandomVariable;
51 {
52 public:
57  static TypeId GetTypeId ();
61  virtual ~MeshWifiInterfaceMac ();
62 
63  // Inherited from WifiMac
64  virtual void Enqueue (Ptr<const Packet> packet, Mac48Address to, Mac48Address from);
65  virtual void Enqueue (Ptr<const Packet> packet, Mac48Address to);
66  virtual bool SupportsSendFrom () const;
67  virtual void SetLinkUpCallback (Callback<void> linkUp);
69  // \{
72  // \}
74  // \{
76  void SetRandomStartDelay (Time interval);
78  void SetBeaconInterval (Time interval);
80  Time GetBeaconInterval () const;
87  Time GetTbtt () const;
96  void ShiftTbtt (Time shift);
97  // \}
98 
107 
108  /*
109  * Channel center frequency = Channel starting frequency + 5 * channel_id (MHz),
110  * where Starting channel frequency is standard-dependent as defined in IEEE 802.11-2007 17.3.8.3.2.
111  *
112  * Number of channels to use must be limited elsewhere.
113  */
114 
119  uint16_t GetFrequencyChannel () const;
125  void SwitchFrequencyChannel (uint16_t new_id);
126 
133  void SendManagementFrame (Ptr<Packet> frame, const WifiMacHeader& hdr);
140  bool CheckSupportedRates (SupportedRates rates) const;
144  // \{
146  uint32_t GetLinkMetric (Mac48Address peerAddress);
147  // \}
149  void Report (std::ostream &) const;
151  void ResetStats ();
157  void SetBeaconGeneration (bool enable);
169  virtual void FinishConfigureStandard (enum WifiPhyStandard standard);
178  int64_t AssignStreams (int64_t stream);
179 private:
186  void Receive (Ptr<Packet> packet, WifiMacHeader const *hdr);
194  void ForwardDown (Ptr<const Packet> packet, Mac48Address from, Mac48Address to);
196  void SendBeacon ();
198  void ScheduleNextBeacon ();
204  bool GetBeaconGeneration () const;
206  virtual void DoDispose ();
207 
208 private:
209  typedef std::vector<Ptr<MeshWifiInterfaceMacPlugin> > PluginList;
210 
211  virtual void DoInitialize ();
212 
214  // \{
223  // \}
224 
227 
233  struct Statistics
235  {
236  uint16_t recvBeacons;
237  uint32_t sentFrames;
238  uint32_t sentBytes;
239  uint32_t recvFrames;
240  uint32_t recvBytes;
241 
246  void Print (std::ostream & os) const;
248  Statistics ();
249  };
251 
254 
257 };
258 
259 } // namespace ns3
260 
261 #endif /* MESH_WIFI_INTERFACE_MAC_H */
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
bool GetBeaconGeneration() const
Get current beaconing status.
Ptr< UniformRandomVariable > m_coefficient
Add randomness to beacon generation.
bool m_beaconEnable
whether beaconing is enabled
virtual void DoDispose()
Real d-tor.
void Report(std::ostream &) const
Statistics:
void SetLinkMetricCallback(Callback< uint32_t, Mac48Address, Ptr< MeshWifiInterfaceMac > > cb)
Time GetTbtt() const
Next beacon frame time.
std::vector< Ptr< MeshWifiInterfaceMacPlugin > > PluginList
PluginList typedef.
WifiPhyStandard GetPhyStandard() const
Get phy standard in use.
void SwitchFrequencyChannel(uint16_t new_id)
Switch frequency channel.
The Supported Rates Information ElementThis class knows how to serialise and deserialise the Supporte...
WifiPhyStandard m_standard
Current PHY standard: needed to configure metric.
virtual void Enqueue(Ptr< const Packet > packet, Mac48Address to, Mac48Address from)
void Print(std::ostream &os) const
Print statistics.
void ResetStats()
Reset statistics.
void SendManagementFrame(Ptr< Packet > frame, const WifiMacHeader &hdr)
To be used by plugins sending management frames.
void ScheduleNextBeacon()
Schedule next beacon.
virtual void DoInitialize()
Initialize() implementation.
WifiPhyStandard
Identifies the PHY specification that a Wifi device is configured to use.
base class for all MAC-level wifi objects.
Mac48Address GetMeshPointAddress() const
virtual bool SupportsSendFrom() const
virtual void FinishConfigureStandard(enum WifiPhyStandard standard)
Finish configuration based on the WifiPhyStandard being provided.
uint32_t GetLinkMetric(Mac48Address peerAddress)
PluginList m_plugins
List of all installed plugins.
SupportedRates GetSupportedRates() const
Mac48Address m_mpAddress
Mesh point address.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Time m_beaconInterval
Beaconing interval.
an EUI-48 address
Definition: mac48-address.h:43
void Receive(Ptr< Packet > packet, WifiMacHeader const *hdr)
Frame receive handler.
Time m_randomStart
Maximum delay before first beacon.
static TypeId GetTypeId()
Get the type ID.
virtual void SetLinkUpCallback(Callback< void > linkUp)
uint16_t GetFrequencyChannel() const
Current channel Id.
Callback< uint32_t, Mac48Address, Ptr< MeshWifiInterfaceMac > > m_linkMetricCallback
linkMetricCallback
void ForwardDown(Ptr< const Packet > packet, Mac48Address from, Mac48Address to)
Send frame.
void SetRandomStartDelay(Time interval)
Set maximum initial random delay before first beacon.
An identifier for simulation events.
Definition: event-id.h:53
void InstallPlugin(Ptr< MeshWifiInterfaceMacPlugin > plugin)
Install plugin.
bool CheckSupportedRates(SupportedRates rates) const
Check supported rates.
void SetBeaconGeneration(bool enable)
Enable/disable beacons.
EventId m_beaconSendEvent
"Timer" for the next beacon
void SetBeaconInterval(Time interval)
Set interval between two successive beacons.
Time m_tbtt
Time for the next frame.
void ShiftTbtt(Time shift)
Shift TBTT.
a unique identifier for an interface.
Definition: type-id.h:58
Basic MAC of mesh point Wi-Fi interface.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
Implements the IEEE 802.11 MAC header.