A Discrete-Event Network Simulator
API
aodv-neighbor.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 * Based on
19 * NS-2 AODV model developed by the CMU/MONARCH group and optimized and
20 * tuned by Samir Das and Mahesh Marina, University of Cincinnati;
21 *
22 * AODV-UU implementation by Erik Nordström of Uppsala University
23 * http://core.it.uu.se/core/index.php/AODV-UU
24 *
25 * Authors: Elena Buchatskaia <borovkovaes@iitp.ru>
26 * Pavel Boyko <boyko@iitp.ru>
27 */
28
29#ifndef AODVNEIGHBOR_H
30#define AODVNEIGHBOR_H
31
32#include <vector>
33#include "ns3/simulator.h"
34#include "ns3/timer.h"
35#include "ns3/ipv4-address.h"
36#include "ns3/callback.h"
37#include "ns3/arp-cache.h"
38
39namespace ns3 {
40
41class WifiMacHeader;
42
43namespace aodv {
44
45class RoutingProtocol;
46
52{
53public:
58 Neighbors (Time delay);
60 struct Neighbor
61 {
69 bool close;
70
79 : m_neighborAddress (ip),
81 m_expireTime (t),
82 close (false)
83 {
84 }
85 };
97 bool IsNeighbor (Ipv4Address addr);
103 void Update (Ipv4Address addr, Time expire);
105 void Purge ();
107 void ScheduleTimer ();
109 void Clear ()
110 {
111 m_nb.clear ();
112 }
113
118 void AddArpCache (Ptr<ArpCache> a);
123 void DelArpCache (Ptr<ArpCache> a);
129 {
130 return m_txErrorCallback;
131 }
132
138 {
140 }
146 {
147 return m_handleLinkFailure;
148 }
149
150private:
158 std::vector<Neighbor> m_nb;
160 std::vector<Ptr<ArpCache> > m_arp;
161
173 void ProcessTxError (WifiMacHeader const &hdr);
174};
175
176} // namespace aodv
177} // namespace ns3
178
179#endif /* AODVNEIGHBOR_H */
Callback template class.
Definition: callback.h:1279
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
an EUI-48 address
Definition: mac48-address.h:44
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
A simple virtual Timer class.
Definition: timer.h:74
Implements the IEEE 802.11 MAC header.
maintain list of active neighbors
Definition: aodv-neighbor.h:52
Time GetExpireTime(Ipv4Address addr)
Return expire time for neighbor node with address addr, if exists, else return 0.
void ScheduleTimer()
Schedule m_ntimer.
Neighbors(Time delay)
constructor
void Clear()
Remove all entries.
void Purge()
Remove all expired entries.
Callback< void, WifiMacHeader const & > GetTxErrorCallback() const
Get callback to ProcessTxError.
std::vector< Ptr< ArpCache > > m_arp
list of ARP cached to be used for layer 2 notifications processing
Mac48Address LookupMacAddress(Ipv4Address addr)
Find MAC address by IP using list of ARP caches.
Callback< void, Ipv4Address > GetCallback() const
Get link failure callback.
void ProcessTxError(WifiMacHeader const &hdr)
Process layer 2 TX error notification.
void Update(Ipv4Address addr, Time expire)
Update expire time for entry with address addr, if it exists, else add new entry.
std::vector< Neighbor > m_nb
vector of entries
Timer m_ntimer
Timer for neighbor's list. Schedule Purge().
Callback< void, Ipv4Address > m_handleLinkFailure
link failure callback
void SetCallback(Callback< void, Ipv4Address > cb)
Set link failure callback.
Callback< void, WifiMacHeader const & > m_txErrorCallback
TX error callback.
void DelArpCache(Ptr< ArpCache > a)
Don't use given ARP cache any more (interface is down)
bool IsNeighbor(Ipv4Address addr)
Check that node with address addr is neighbor.
void AddArpCache(Ptr< ArpCache > a)
Add ARP cache to be used to allow layer 2 notifications processing.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
mac
Definition: third.py:96
Neighbor description.
Definition: aodv-neighbor.h:61
bool close
Neighbor close indicator.
Definition: aodv-neighbor.h:69
Neighbor(Ipv4Address ip, Mac48Address mac, Time t)
Neighbor structure constructor.
Definition: aodv-neighbor.h:78
Mac48Address m_hardwareAddress
Neighbor MAC address.
Definition: aodv-neighbor.h:65
Ipv4Address m_neighborAddress
Neighbor IPv4 address.
Definition: aodv-neighbor.h:63
Time m_expireTime
Neighbor expire time.
Definition: aodv-neighbor.h:67