A Discrete-Event Network Simulator
API
hwmp-rtable.h
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  * Author: Kirill Andreev <andreev@iitp.ru>
19  */
20 
21 #ifndef HWMP_RTABLE_H
22 #define HWMP_RTABLE_H
23 
24 #include <map>
25 #include "ns3/nstime.h"
26 #include "ns3/mac48-address.h"
27 #include "ns3/hwmp-protocol.h"
28 namespace ns3 {
29 namespace dot11s {
35 class HwmpRtable : public Object
36 {
37 public:
39  const static uint32_t INTERFACE_ANY = 0xffffffff;
41  const static uint32_t MAX_METRIC = 0xffffffff;
42 
44  struct LookupResult
45  {
47  uint32_t ifIndex;
48  uint32_t metric;
49  uint32_t seqnum;
61  uint32_t i = INTERFACE_ANY,
62  uint32_t m = MAX_METRIC,
63  uint32_t s = 0,
64  Time l = Seconds (0.0));
68  bool IsValid () const;
74  bool operator== (const LookupResult & o) const;
75  };
77  typedef std::vector<std::pair<uint32_t, Mac48Address> > PrecursorList;
78 
79 public:
84  static TypeId GetTypeId ();
85  HwmpRtable ();
86  ~HwmpRtable ();
87  void DoDispose ();
88 
91 
101  void AddReactivePath (
102  Mac48Address destination,
103  Mac48Address retransmitter,
104  uint32_t interface,
105  uint32_t metric,
106  Time lifetime,
107  uint32_t seqnum
108  );
118  void AddProactivePath (
119  uint32_t metric,
120  Mac48Address root,
121  Mac48Address retransmitter,
122  uint32_t interface,
123  Time lifetime,
124  uint32_t seqnum
125  );
133  void AddPrecursor (Mac48Address destination, uint32_t precursorInterface, Mac48Address precursorAddress, Time lifetime);
134 
141 
145  void DeleteProactivePath ();
150  void DeleteProactivePath (Mac48Address root);
155  void DeleteReactivePath (Mac48Address destination);
157 
160 
183 
189  std::vector<HwmpProtocol::FailedDestination> GetUnreachableDestinations (Mac48Address peerAddress);
190 
191 private:
193  struct Precursor
194  {
196  uint32_t interface;
198  };
201  {
203  uint32_t interface;
204  uint32_t metric;
206  uint32_t seqnum;
207  std::vector<Precursor> precursors;
208  };
211  {
214  uint32_t interface;
215  uint32_t metric;
217  uint32_t seqnum;
218  std::vector<Precursor> precursors;
219  };
220 
222  std::map<Mac48Address, ReactiveRoute> m_routes;
225 };
226 } // namespace dot11s
227 } // namespace ns3
228 #endif
an EUI-48 address
Definition: mac48-address.h:44
static Mac48Address GetBroadcast(void)
A base class which provides memory management and object aggregation.
Definition: object.h:88
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
a unique identifier for an interface.
Definition: type-id.h:59
Routing table for HWMP – 802.11s routing protocol.
Definition: hwmp-rtable.h:36
void DeleteReactivePath(Mac48Address destination)
Delete the reactive paths toward a destination.
Definition: hwmp-rtable.cc:140
void DoDispose()
Destructor implementation.
Definition: hwmp-rtable.cc:54
static const uint32_t INTERFACE_ANY
Means all interfaces.
Definition: hwmp-rtable.h:39
static const uint32_t MAX_METRIC
Maximum (the best?) path metric.
Definition: hwmp-rtable.h:41
LookupResult LookupReactive(Mac48Address destination)
Lookup path to destination.
Definition: hwmp-rtable.cc:150
LookupResult LookupReactiveExpired(Mac48Address destination)
Return all reactive paths, including expired.
Definition: hwmp-rtable.cc:166
static TypeId GetTypeId()
Get the type ID.
Definition: hwmp-rtable.cc:38
std::map< Mac48Address, ReactiveRoute > m_routes
List of routes.
Definition: hwmp-rtable.h:222
PrecursorList GetPrecursors(Mac48Address destination)
Get the precursors list.
Definition: hwmp-rtable.cc:223
void DeleteProactivePath()
Delete all the proactive paths.
Definition: hwmp-rtable.cc:120
LookupResult LookupProactiveExpired()
Return all proactive paths, including expired.
Definition: hwmp-rtable.cc:190
std::vector< std::pair< uint32_t, Mac48Address > > PrecursorList
Path precursor = {MAC, interface ID}.
Definition: hwmp-rtable.h:77
std::vector< HwmpProtocol::FailedDestination > GetUnreachableDestinations(Mac48Address peerAddress)
When peer link with a given MAC-address fails - it returns list of unreachable destination addresses.
Definition: hwmp-rtable.cc:198
ProactiveRoute m_root
Path to proactive tree root MP.
Definition: hwmp-rtable.h:224
LookupResult LookupProactive()
Find proactive path to tree root.
Definition: hwmp-rtable.cc:179
void AddPrecursor(Mac48Address destination, uint32_t precursorInterface, Mac48Address precursorAddress, Time lifetime)
Add a precursor.
Definition: hwmp-rtable.cc:90
void AddProactivePath(uint32_t metric, Mac48Address root, Mac48Address retransmitter, uint32_t interface, Time lifetime, uint32_t seqnum)
Add a proactive path.
Definition: hwmp-rtable.cc:78
void AddReactivePath(Mac48Address destination, Mac48Address retransmitter, uint32_t interface, uint32_t metric, Time lifetime, uint32_t seqnum)
Add a reactive path.
Definition: hwmp-rtable.cc:59
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1244
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Route lookup result, return type of LookupXXX methods.
Definition: hwmp-rtable.h:45
LookupResult(Mac48Address r=Mac48Address::GetBroadcast(), uint32_t i=INTERFACE_ANY, uint32_t m=MAX_METRIC, uint32_t s=0, Time l=Seconds(0.0))
Lookup result function.
Definition: hwmp-rtable.cc:248
bool operator==(const LookupResult &o) const
Compare route lookup results, used by tests.
Definition: hwmp-rtable.cc:243
uint32_t seqnum
sequence number
Definition: hwmp-rtable.h:49
Mac48Address retransmitter
retransmitter
Definition: hwmp-rtable.h:46
Route found in reactive mode.
Definition: hwmp-rtable.h:194
Route found in proactive mode.
Definition: hwmp-rtable.h:211
std::vector< Precursor > precursors
precursors
Definition: hwmp-rtable.h:218
Mac48Address retransmitter
retransmitter
Definition: hwmp-rtable.h:213
Route found in reactive mode.
Definition: hwmp-rtable.h:201
Mac48Address retransmitter
transmitter
Definition: hwmp-rtable.h:202
std::vector< Precursor > precursors
precursors
Definition: hwmp-rtable.h:207
uint32_t seqnum
sequence number
Definition: hwmp-rtable.h:206