A Discrete-Event Network Simulator
API
dsr-rreq-table.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2011 Yufei Cheng
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: Yufei Cheng <yfcheng@ittc.ku.edu>
19 *
20 * James P.G. Sterbenz <jpgs@ittc.ku.edu>, director
21 * ResiliNets Research Group https://resilinets.org/
22 * Information and Telecommunication Technology Center (ITTC)
23 * and Department of Electrical Engineering and Computer Science
24 * The University of Kansas Lawrence, KS USA.
25 *
26 * Work supported in part by NSF FIND (Future Internet Design) Program
27 * under grant CNS-0626918 (Postmodern Internet Architecture),
28 * NSF grant CNS-1050226 (Multilayer Network Resilience Analysis and Experimentation on GENI),
29 * US Department of Defense (DoD), and ITTC at The University of Kansas.
30 */
31
32#ifndef DSR_RREQ_TABLE_H
33#define DSR_RREQ_TABLE_H
34
35#include "ns3/simulator.h"
36#include "ns3/timer.h"
37#include "ns3/ipv4-address.h"
38#include "ns3/callback.h"
39#include <list>
40#include <vector>
41#include <map>
42
43namespace ns3 {
44namespace dsr {
45
50{
53};
56{
60
68 : m_neighborAddress (ip),
69 m_expireTime (t),
71 {
72 }
73};
78{
81};
87{
88public:
96 : m_destination (d),
98 {
99 }
105 bool operator== (DsrReceivedRreqEntry const & o) const
106 {
108 );
109 }
110
117 {
118 return m_destination;
119 }
126 {
127 m_destination = d;
128 }
135 {
136 return m_source;
137 }
144 {
145 m_source = s;
146 }
152 uint16_t GetIdentification () const
153 {
154 return m_identification;
155 }
161 void SetIdentification (uint16_t i)
162 {
164 }
173 {
174 m_expire = exp + Simulator::Now ();
175 }
184 {
185 return m_expire - Simulator::Now ();
186 }
187 // \}
188private:
193};
194
199class DsrRreqTable : public Object
200{
201public:
206 static TypeId GetTypeId ();
207
208 DsrRreqTable ();
209 virtual ~DsrRreqTable ();
210
217 {
218 m_initHopLimit = hl;
219 }
226 {
227 return m_initHopLimit;
228 }
236 {
238 }
246 {
247 return m_requestTableSize;
248 }
256 {
257 m_requestIdSize = id;
258 }
266 {
267 return m_requestIdSize;
268 }
276 {
277 m_maxRreqId = uid;
278 }
286 {
287 return m_maxRreqId;
288 }
289
291 void RemoveLeastExpire ();
294 void FindAndUpdate (Ipv4Address dst);
297 void RemoveRreqEntry (Ipv4Address dst);
302
317
321 void Invalidate ();
334 bool MarkLinkAsUnidirectional (Ipv4Address neighbor, Time blacklistTimeout);
338 void PurgeNeighbor ();
339
347 bool FindSourceEntry (Ipv4Address src, Ipv4Address dst, uint16_t id);
348
349private:
369 std::list<DsrReceivedRreqEntry> m_sourceRequests;
371 std::map<Ipv4Address, uint32_t> m_rreqIdCache;
373 std::map<Ipv4Address, RreqTableEntry > m_rreqDstMap;
375 std::map<Ipv4Address, std::list<DsrReceivedRreqEntry> > m_sourceRreqMap;
376
378 std::vector<BlackList> m_blackList;
381 {
388 bool operator() (const struct BlackList & b) const
389 {
390 return (b.m_expireTime < Simulator::Now ());
391 }
392 };
393};
394} // namespace dsr
395} // namespace ns3
396
397#endif /* DSR_RREQ_TABLE_H */
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
A base class which provides memory management and object aggregation.
Definition: object.h:88
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:195
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
a unique identifier for an interface.
Definition: type-id.h:59
The request entry for intermediate nodes to check if they have received this request or not This is u...
void SetExpireTime(Time exp)
Set expire time for the RREQ entry.
Ipv4Address GetDestination() const
Return IPv4 address of the destination.
void SetIdentification(uint16_t i)
Set identification.
Ipv4Address m_source
IPv4 address of the source.
void SetSource(Ipv4Address s)
Set IPv4 address of the source.
Time GetExpireTime() const
Return the remaining time before the RREQ entry expires.
void SetDestination(Ipv4Address d)
Set IPv4 address of the destination.
Time m_expire
Route request expire time.
DsrReceivedRreqEntry(Ipv4Address d=Ipv4Address(), uint16_t i=0)
Construct a DsrReceivedRreqEntry with the given parameters.
uint16_t m_identification
Route request identification.
bool operator==(DsrReceivedRreqEntry const &o) const
Compare send buffer entries (destination address and identification)
Ipv4Address GetSource() const
Return IPv4 address of the source.
Ipv4Address m_destination
IPv4 address of the destinaton.
uint16_t GetIdentification() const
Return identification.
maintain list of DsrRreqTable entry
Time NonpropRequestTimeout
The non-propagaton request timeout.
void FindAndUpdate(Ipv4Address dst)
Find the entry in the route request queue to see if already exists.
void RemoveLeastExpire()
Remove the least used entry.
std::map< Ipv4Address, std::list< DsrReceivedRreqEntry > > m_sourceRreqMap
The cache to ensure all the route request from unique source.
uint32_t CheckUniqueRreqId(Ipv4Address dst)
The following code generates new request id for each destination.
std::map< Ipv4Address, uint32_t > m_rreqIdCache
The id cache to ensure all the ids are unique, it is used when sending out route request.
void SetUniqueRreqIdSize(uint32_t uid)
Set the maximum number of request Ids in the request table for a single destination.
Time MaxRequestPeriod
The max request period among requests.
LinkStates m_linkStates
The state of the unidirectional link.
uint32_t m_initHopLimit
The initial hop limit.
void Invalidate()
set the unidirectional entry as QUESTIONABLE state
void SetInitHopLimit(uint32_t hl)
Set the initial discovert hop limit.
Time m_rreqEntryExpire
The source route entry expire time.
void RemoveRreqEntry(Ipv4Address dst)
Remove route request entry for dst.
uint32_t GetRreqIdSize() const
Return the maximum number of request source Ids in the request table.
std::map< Ipv4Address, RreqTableEntry > m_rreqDstMap
The cache to save route request table entries indexed with destination address.
std::vector< BlackList > m_blackList
The Black list.
uint32_t GetUniqueRreqIdSize() const
Return the maximum number of request Ids in the request table for a single destination.
uint32_t m_maxRreqId
The unique request id for any destination.
std::list< DsrReceivedRreqEntry > m_sourceRequests
Map of entries.
Time RequestPeriod
The original request period.
bool MarkLinkAsUnidirectional(Ipv4Address neighbor, Time blacklistTimeout)
Mark entry as unidirectional (e.g.
uint32_t m_requestTableSize
The request table size.
uint32_t GetRreqCnt(Ipv4Address dst)
Get the request count number for one destination address.
void SetRreqTableSize(uint32_t rt)
Set the maximum number of request entries in the request table.
static TypeId GetTypeId()
Get the type ID.
uint32_t GetRreqTableSize() const
Return the maximum number of request entries in the request table.
uint32_t m_requestIdSize
The request source id size.
void PurgeNeighbor()
Remove all expired black list entries.
bool FindSourceEntry(Ipv4Address src, Ipv4Address dst, uint16_t id)
Find the source request entry in the route request queue, return false if not found.
BlackList * FindUnidirectional(Ipv4Address neighbor)
Verify if entry is unidirectional or not(e.g.
uint32_t GetInitHopLimit() const
Return the initial discovert hop limit.
void SetRreqIdSize(uint32_t id)
Set the maximum number of request source Ids in the request table.
uint32_t GetRreqSize()
Get the request id size.
LinkStates
State of link.
@ PROBABLE
PROBABLE.
@ QUESTIONABLE
QUESTIONABLE.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
BlackList description.
Time m_expireTime
Expire time in the black list.
LinkStates m_linkStates
State of the link.
BlackList(Ipv4Address ip, Time t)
Construct a BlackList with the given parameters.
Ipv4Address m_neighborAddress
IPv4 address of the black-listed neighbor.
Check if the entry is expired or not.
bool operator()(const struct BlackList &b) const
Check if the entry is expired.
The route request table entries.
Time m_expire
Expire time.
uint32_t m_reqNo
Route request number.