A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
peer-management-protocol-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  * Author: Kirill Andreev <andreev@iitp.ru>
19  */
20 
21 #ifndef PEER_MANAGEMENT_PROTOCOL_MAC_H
22 #define PEER_MANAGEMENT_PROTOCOL_MAC_H
23 
24 #include "ns3/mesh-wifi-interface-mac-plugin.h"
25 
26 namespace ns3 {
27 class MeshWifiInterfaceMac;
28 namespace dot11s {
29 class PeerManagementProtocol;
30 class IeConfiguration;
31 class IePeerManagement;
32 class PeerManagementProtocol;
42 class PeerManagementProtocolMac : public MeshWifiInterfaceMacPlugin
43 {
44 public:
45  PeerManagementProtocolMac (uint32_t interface, Ptr<PeerManagementProtocol> protocol);
46  ~PeerManagementProtocolMac ();
48  // \{
49  void SetParent (Ptr<MeshWifiInterfaceMac> parent);
50  bool Receive (Ptr<Packet> packet, const WifiMacHeader & header);
51  bool UpdateOutcomingFrame (Ptr<Packet> packet, WifiMacHeader & header, Mac48Address from, Mac48Address to);
52  void UpdateBeacon (MeshWifiBeacon & beacon) const;
53  int64_t AssignStreams (int64_t stream);
54  // \}
56  // \{
57  void Report (std::ostream &) const;
58  void ResetStats ();
59  uint32_t GetLinkMetric (Mac48Address peerAddress);
60  // \}
61 
62 private:
63  PeerManagementProtocolMac& operator= (const PeerManagementProtocolMac &);
64  PeerManagementProtocolMac (const PeerManagementProtocolMac &);
65 
66  friend class PeerManagementProtocol;
67  friend class PeerLink;
69  // \{
74  struct PlinkFrameStart
75  {
76  uint8_t subtype;
77  uint16_t aid;
78  SupportedRates rates;
79  uint16_t qos;
80  };
81  Ptr<Packet> CreatePeerLinkOpenFrame ();
82  Ptr<Packet> CreatePeerLinkConfirmFrame ();
83  Ptr<Packet> CreatePeerLinkCloseFrame ();
85  PlinkFrameStart ParsePlinkFrame (Ptr<const Packet> packet);
86  // \}
88  void TxError (WifiMacHeader const &hdr);
89  void TxOk (WifiMacHeader const &hdr);
91  void SetBeaconShift (Time shift);
92  void SetPeerManagerProtcol (Ptr<PeerManagementProtocol> protocol);
93  void SendPeerLinkManagementFrame (
94  Mac48Address peerAddress,
95  Mac48Address peerMpAddress,
96  uint16_t aid,
97  IePeerManagement peerElement,
98  IeConfiguration meshConfig
99  );
101  Mac48Address GetAddress () const;
103  // \{
104  struct Statistics
105  {
106  uint16_t txOpen;
107  uint16_t txConfirm;
108  uint16_t txClose;
109  uint16_t rxOpen;
110  uint16_t rxConfirm;
111  uint16_t rxClose;
112  uint16_t dropped;
113  uint16_t brokenMgt;
114  uint16_t txMgt;
115  uint32_t txMgtBytes;
116  uint16_t rxMgt;
117  uint32_t rxMgtBytes;
118  uint16_t beaconShift;
119 
120  Statistics ();
121  void Print (std::ostream & os) const;
122  };
123 
124 private:
125  struct Statistics m_stats;
128  // \{
129  Ptr<MeshWifiInterfaceMac> m_parent;
130  uint32_t m_ifIndex;
131  Ptr<PeerManagementProtocol> m_protocol;
132  // \}
133 };
134 
135 } // namespace dot11s
136 } // namespace ns3
137 
138 #endif /* PEER_MANAGEMENT_PROTOCOL_MAC_H */
139