A Discrete-Event Network Simulator
API
ie-dot11s-configuration.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008,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  * Aleksey Kovalenko <kovalenko@iitp.ru>
20  */
21 
23 #include "ns3/packet.h"
24 namespace ns3 {
25 namespace dot11s {
26 
28  acceptPeerLinks (true), MCCASupported (false), MCCAEnabled (false), forwarding (true), beaconTimingReport (
29  true), TBTTAdjustment (true), powerSaveLevel (false)
30 {
31 }
32 uint8_t
34 {
35  return 1;
36 }
37 uint8_t
38 Dot11sMeshCapability::GetUint8 () const //IEEE 802.11-2012 8.4.2.100.8 Mesh Capability
39 {
40  uint8_t result = 0;
41  if (acceptPeerLinks)
42  {
43  result |= 1 << 0; //The Accepting Additional Mesh Peerings subfield is set to 1 if the mesh STA is willing to establish additional mesh peerings with other mesh STAs and set to 0 otherwise
44  }
45  if (MCCASupported) // The MCCA Supported subfield is set to 1 if the mesh STA implements MCCA and set to 0 otherwise
46  {
47  result |= 1 << 1;
48  }
49  if (MCCAEnabled)
50  {
51  result |= 1 << 2;
52  }
53  if (forwarding)
54  {
55  result |= 1 << 3;
56  }
58  {
59  result |= 1 << 4;
60  }
61  if (TBTTAdjustment)
62  {
63  result |= 1 << 5;
64  }
65  if (powerSaveLevel)
66  {
67  result |= 1 << 6;
68  }
69  return result;
70 }
73 {
74  i.WriteU8 (GetUint8 ());
75  return i;
76 }
79 {
80  uint8_t cap = i.ReadU8 ();
81  acceptPeerLinks = Is (cap, 0);
82  MCCASupported = Is (cap, 1);
83  MCCAEnabled = Is (cap, 2);
84  forwarding = Is (cap, 3);
85  beaconTimingReport = Is (cap, 4);
86  TBTTAdjustment = Is (cap, 5);
87  powerSaveLevel = Is (cap, 6);
88  return i;
89 }
90 bool
91 Dot11sMeshCapability::Is (uint8_t cap, uint8_t n) const
92 {
93  uint16_t mask = 1 << n;
94  return (cap & mask);
95 }
98 {
99  return IE_MESH_CONFIGURATION;
100 }
101 
103  m_APSPId (PROTOCOL_HWMP), m_APSMId (METRIC_AIRTIME), m_CCMId (CONGESTION_NULL), m_SPId (
104  SYNC_NEIGHBOUR_OFFSET), m_APId (AUTH_NULL), m_neighbors (0)
105 {
106 }
107 uint8_t
109 {
110  return 0 // Version
111  + 1 // APSPId
112  + 1 // APSMId
113  + 1 // CCMId
114  + 1 // SPId
115  + 1 // APId
116  + 1 // Mesh formation info (see 7.3.2.86.6 of 802.11s draft 3.0)
118 }
119 void
121 {
122  // Active Path Selection Protocol ID:
123  i.WriteU8 (m_APSPId);
124  // Active Path Metric ID:
125  i.WriteU8 (m_APSMId);
126  // Congestion Control Mode ID:
127  i.WriteU8 (m_CCMId);
128  // Sync:
129  i.WriteU8 (m_SPId);
130  // Auth:
131  i.WriteU8 (m_APId);
132  i.WriteU8 (m_neighbors << 1);
133  m_meshCap.Serialize (i);
134 }
135 uint8_t
137 {
139  // Active Path Selection Protocol ID:
141  // Active Path Metric ID:
143  // Congestion Control Mode ID:
147  m_neighbors = (i.ReadU8 () >> 1) & 0xF;
148  i = m_meshCap.Deserialize (i);
149  return i.GetDistanceFrom (start);
150 }
151 void
152 IeConfiguration::Print (std::ostream& os) const
153 {
154  os << "MeshConfiguration=(neighbors=" << (uint16_t) m_neighbors
155  << ", Active Path Selection Protocol ID=" << (uint32_t) m_APSPId
156  << ", Active Path Selection Metric ID=" << (uint32_t) m_APSMId
157  << ", Congestion Control Mode ID=" << (uint32_t) m_CCMId
158  << ", Synchronize protocol ID=" << (uint32_t) m_SPId
159  << ", Authentication protocol ID=" << (uint32_t) m_APId
160  << ", Capabilities=" << m_meshCap.GetUint8 ();
161  os << ")";
162 }
163 void
165 {
166  m_APSPId = routingId;
167 }
168 void
170 {
171  m_APSMId = metricId;
172 }
173 bool
175 {
176  return (m_APSPId == PROTOCOL_HWMP);
177 }
178 bool
180 {
181  return (m_APSMId == METRIC_AIRTIME);
182 }
183 void
185 {
186  m_neighbors = (neighbors > 31) ? 31 : neighbors;
187 }
188 uint8_t
190 {
191  return m_neighbors;
192 }
195 {
196  return m_meshCap;
197 }
198 bool
200 {
201  return ((a.acceptPeerLinks == b.acceptPeerLinks) && (a.MCCASupported == b.MCCASupported) && (a.MCCAEnabled
204 }
205 bool
207 {
208  return ((a.m_APSPId == b.m_APSPId) && (a.m_APSMId == b.m_APSMId) && (a.m_CCMId == b.m_CCMId) && (a.m_SPId
209  == b.m_SPId) && (a.m_APId == b.m_APId) && (a.m_neighbors == b.m_neighbors) && (a.m_meshCap
210  == b.m_meshCap));
211 }
212 std::ostream &
213 operator << (std::ostream &os, const IeConfiguration &a)
214 {
215  a.Print (os);
216  return os;
217 }
218 } // namespace dot11s
219 } // namespace ns3
220 
friend bool operator==(const IeConfiguration &a, const IeConfiguration &b)
equality operator
uint8_t GetSerializedSize() const
Size of the field in bytes when serialized.
dot11sAuthenticationProtocol m_APId
Auth protocol ID.
virtual void SerializeInformationField(Buffer::Iterator i) const
Serialize information (i.e., the body of the IE, not including the Element ID and length octets) ...
uint8_t GetUint8() const
The Mesh Capability is expressed in terms of 8 single bit fields.
virtual uint8_t DeserializeInformationField(Buffer::Iterator i, uint8_t length)
Deserialize information (i.e., the body of the IE, not including the Element ID and length octets) ...
bool beaconTimingReport
beacon timing report
def start()
Definition: core.py:1806
#define IE_MESH_CONFIGURATION
virtual WifiInformationElementId ElementId() const
Buffer::Iterator Serialize(Buffer::Iterator i) const
Serialize to a buffer.
dot11sPathSelectionMetric m_APSMId
Active Path Metric ID.
uint32_t GetDistanceFrom(Iterator const &o) const
Definition: buffer.cc:786
iterator in a Buffer instance
Definition: buffer.h:98
dot11sPathSelectionProtocol m_APSPId
Active Path Selection Protocol ID.
dot11sCongestionControlMode m_CCMId
Congestion Control Mode ID.
virtual void Print(std::ostream &os) const
Generate human-readable form of IE.
A set of values indicating whether a mesh STA is a possible candidate for mesh peering establishment ...
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool Is(uint8_t cap, uint8_t n) const
This is a utility function to test if the bit at position n is true.
Dot11sMeshCapability const & MeshCapability()
Mesh capability.
void SetMetric(dot11sPathSelectionMetric metricId)
Set metric value.
bool IsAirtime()
Is airtime function.
uint8_t GetNeighborCount()
Get neighbor count.
void WriteU8(uint8_t data)
Definition: buffer.h:869
dot11sSynchronizationProtocolIdentifier m_SPId
Sync protocol ID.
Describes Mesh Configuration Element see 7.3.2.86 of 802.11s draft 3.0.
void SetNeighborCount(uint8_t neighbors)
Set neighbor count.
uint8_t ReadU8(void)
Definition: buffer.h:1021
Dot11sMeshCapability m_meshCap
Mesh capability.
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.
Buffer::Iterator Deserialize(Buffer::Iterator i)
Deserialize from a buffer.
std::ostream & operator<<(std::ostream &os, const IeBeaconTiming &a)
void SetRouting(dot11sPathSelectionProtocol routingId)
Set routing value.
virtual uint8_t GetInformationFieldSize() const
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...