A Discrete-Event Network Simulator
API
flame-rtable.cc
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 #include "ns3/assert.h"
21 #include "ns3/simulator.h"
22 #include "ns3/test.h"
23 #include "ns3/log.h"
24 
25 #include "flame-rtable.h"
26 
27 namespace ns3 {
28 
29 NS_LOG_COMPONENT_DEFINE ("FlameRtable");
30 
31 namespace flame {
32 
33 NS_OBJECT_ENSURE_REGISTERED (FlameRtable);
34 
35 TypeId
37 {
38  static TypeId tid =
39  TypeId ("ns3::flame::FlameRtable")
40  .SetParent<Object> ().AddConstructor<FlameRtable> ()
41  .AddAttribute ( "Lifetime",
42  "The lifetime of the routing enrty",
46  )
47  ;
48  return tid;
49 }
51  m_lifetime (Seconds (120))
52 {
53 }
55 {
56 }
57 void
59 {
60  m_routes.clear ();
61 }
62 void
63 FlameRtable::AddPath (const Mac48Address destination, const Mac48Address retransmitter,
64  const uint32_t interface, const uint8_t cost, const uint16_t seqnum)
65 {
66  std::map<Mac48Address, Route>::iterator i = m_routes.find (destination);
67  if (i == m_routes.end ())
68  {
69  Route newroute;
70  newroute.cost = cost;
71  newroute.retransmitter = retransmitter;
72  newroute.interface = interface;
73  newroute.whenExpire = Simulator::Now () + m_lifetime;
74  newroute.seqnum = seqnum;
75  m_routes[destination] = newroute;
76  return;
77  }
78  i->second.seqnum = seqnum;
79  NS_ASSERT (i != m_routes.end ());
80  i->second.retransmitter = retransmitter;
81  i->second.interface = interface;
82  i->second.cost = cost;
83  i->second.whenExpire = Simulator::Now () + m_lifetime;
84 }
87 {
88  std::map<Mac48Address, Route>::iterator i = m_routes.find (destination);
89  if (i == m_routes.end ())
90  {
91  return LookupResult ();
92  }
93  if ((i->second.whenExpire < Simulator::Now ()))
94  {
95  NS_LOG_DEBUG ("Route has expired, sorry.");
96  m_routes.erase (i);
97  return LookupResult ();
98  }
99  return LookupResult (i->second.retransmitter, i->second.interface, i->second.cost, i->second.seqnum);
100 }
101 bool
103 {
104  return (retransmitter == o.retransmitter && ifIndex == o.ifIndex && cost == o.cost && seqnum == o.seqnum);
105 }
106 
107 bool
109 {
110  return !(retransmitter == Mac48Address::GetBroadcast () && ifIndex == INTERFACE_ANY && cost == MAX_COST
111  && seqnum == 0);
112 }
113 
114 } // namespace flame
115 } // namespace ns3
static const uint32_t MAX_COST
Maximum (the best?) path cost.
Definition: flame-rtable.h:42
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:44
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:63
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:61
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
std::map< Mac48Address, Route > m_routes
List of routes.
Definition: flame-rtable.h:101
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:439
AttributeValue implementation for Time.
Definition: nstime.h:921
static Mac48Address GetBroadcast(void)
Time m_lifetime
Lifetime parameter.
Definition: flame-rtable.h:99
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
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: nstime.h:922
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:223
bool operator==(const LookupResult &o) const
Compare route lookup results, used by tests.
static TypeId GetTypeId()
Definition: flame-rtable.cc:36
static const uint32_t INTERFACE_ANY
Means all interfaces.
Definition: flame-rtable.h:40
bool IsValid() const
True for valid route.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:236
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:859
A base class which provides memory management and object aggregation.
Definition: object.h:87
Routing table entry.
Definition: flame-rtable.h:90
void DoDispose()
Destructor implementation.
Definition: flame-rtable.cc:58
a unique identifier for an interface.
Definition: type-id.h:51
TypeId SetParent(TypeId tid)
Definition: type-id.cc:631
LookupResult Lookup(Mac48Address destination)
Lookup path to destination.
Definition: flame-rtable.cc:86