A Discrete-Event Network Simulator
API
flame-rtable.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 FLAME_RTABLE_H
22 #define FLAME_RTABLE_H
23 
24 #include <map>
25 #include "ns3/nstime.h"
26 #include "ns3/object.h"
27 #include "ns3/mac48-address.h"
28 
29 namespace ns3 {
30 namespace flame {
36 class FlameRtable : public Object
37 {
38 public:
40  const static uint32_t INTERFACE_ANY = 0xffffffff;
42  const static uint32_t MAX_COST = 0xff;
43 
45  struct LookupResult
46  {
48  uint32_t ifIndex;
49  uint8_t cost;
50  uint16_t seqnum;
51 
60  uint32_t i = INTERFACE_ANY,
61  uint8_t c = MAX_COST,
62  uint16_t s = 0)
63  : retransmitter (r),
64  ifIndex (i),
65  cost (c),
66  seqnum (s)
67  {
68  }
72  bool IsValid () const;
79  bool operator== (const LookupResult & o) const;
80  };
81 public:
86  static TypeId GetTypeId ();
87  FlameRtable ();
88  ~FlameRtable ();
89  void DoDispose ();
90 
100  void AddPath (
101  const Mac48Address destination,
102  const Mac48Address retransmitter,
103  const uint32_t interface,
104  const uint8_t cost,
105  const uint16_t seqnum
106  );
112  LookupResult Lookup (Mac48Address destination);
113 private:
120  FlameRtable& operator= (const FlameRtable & table);
122  FlameRtable (const FlameRtable &);
123 
125  struct Route
126  {
128  uint32_t interface;
129  uint32_t cost;
131  uint32_t seqnum;
132  };
136  std::map<Mac48Address, Route> m_routes;
137 };
138 
139 } // namespace flame
140 } // namespace ns3
141 #endif /* FLAME_PROTOCOL_H */
static const uint32_t MAX_COST
Maximum (the best?) path cost.
Definition: flame-rtable.h:42
Routing table for FLAME.
Definition: flame-rtable.h:36
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
void AddPath(const Mac48Address destination, const Mac48Address retransmitter, const uint32_t interface, const uint8_t cost, const uint16_t seqnum)
Add path.
Definition: flame-rtable.cc:65
FlameRtable & operator=(const FlameRtable &table)
assignment operator
Mac48Address retransmitter
retransmitter
Definition: flame-rtable.h:127
std::map< Mac48Address, Route > m_routes
List of routes.
Definition: flame-rtable.h:136
Mac48Address retransmitter
retransmitter
Definition: flame-rtable.h:47
static Mac48Address GetBroadcast(void)
uint32_t seqnum
sequence number
Definition: flame-rtable.h:131
uint16_t seqnum
sequence number
Definition: flame-rtable.h:50
Time m_lifetime
Lifetime parameter.
Definition: flame-rtable.h:134
uint32_t interface
interface
Definition: flame-rtable.h:128
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Route lookup result, return type of LookupXXX methods.
Definition: flame-rtable.h:45
an EUI-48 address
Definition: mac48-address.h:43
bool operator==(const LookupResult &o) const
Compare route lookup results, used by tests.
static TypeId GetTypeId()
Get the type ID.
Definition: flame-rtable.cc:36
static const uint32_t INTERFACE_ANY
Means all interfaces.
Definition: flame-rtable.h:40
LookupResult(Mac48Address r=Mac48Address::GetBroadcast(), uint32_t i=INTERFACE_ANY, uint8_t c=MAX_COST, uint16_t s=0)
Constructor.
Definition: flame-rtable.h:59
A base class which provides memory management and object aggregation.
Definition: object.h:87
Routing table entry.
Definition: flame-rtable.h:125
void DoDispose()
Destructor implementation.
Definition: flame-rtable.cc:60
Time whenExpire
expire when?
Definition: flame-rtable.h:130
a unique identifier for an interface.
Definition: type-id.h:58
LookupResult Lookup(Mac48Address destination)
Lookup path to destination.
Definition: flame-rtable.cc:88