A Discrete-Event Network Simulator
API
ipv4-routing-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 INRIA
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #ifndef IPV4_ROUTING_HELPER_H
22 #define IPV4_ROUTING_HELPER_H
23 
24 #include "ns3/ptr.h"
25 #include "ns3/nstime.h"
26 #include "ns3/output-stream-wrapper.h"
27 #include "ns3/ipv4-list-routing.h"
28 
29 namespace ns3 {
30 
31 class Ipv4RoutingProtocol;
32 class Node;
33 
46 {
47 public:
48  /*
49  * Destroy an instance of an Ipv4RoutingHelper
50  */
51  virtual ~Ipv4RoutingHelper ();
52 
60  virtual Ipv4RoutingHelper* Copy (void) const = 0;
61 
66  virtual Ptr<Ipv4RoutingProtocol> Create (Ptr<Node> node) const = 0;
67 
78  static void PrintRoutingTableAllAt (Time printTime, Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S);
79 
90  static void PrintRoutingTableAllEvery (Time printInterval, Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S);
91 
103  static void PrintRoutingTableAt (Time printTime, Ptr<Node> node, Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S);
104 
116  static void PrintRoutingTableEvery (Time printInterval, Ptr<Node> node, Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S);
117 
131  static void PrintNeighborCacheAllAt (Time printTime, Ptr<OutputStreamWrapper> stream);
132 
146  static void PrintNeighborCacheAllEvery (Time printInterval, Ptr<OutputStreamWrapper> stream);
147 
162  static void PrintNeighborCacheAt (Time printTime, Ptr<Node> node, Ptr<OutputStreamWrapper> stream);
163 
178  static void PrintNeighborCacheEvery (Time printInterval, Ptr<Node> node, Ptr<OutputStreamWrapper> stream);
179 
189  template<class T>
190  static Ptr<T> GetRouting (Ptr<Ipv4RoutingProtocol> protocol);
191 
192 private:
203  static void Print (Ptr<Node> node, Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S);
204 
216  static void PrintEvery (Time printInterval, Ptr<Node> node, Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S);
217 
231  static void PrintArpCache (Ptr<Node> node, Ptr<OutputStreamWrapper> stream);
232 
247  static void PrintArpCacheEvery (Time printInterval, Ptr<Node> node, Ptr<OutputStreamWrapper> stream);
248 };
249 
250 
260 template<class T>
262 {
263  Ptr<T> ret = DynamicCast<T> (protocol);
264  if (ret == 0)
265  {
266  // trying to check if protocol is a list routing
267  Ptr<Ipv4ListRouting> lrp = DynamicCast<Ipv4ListRouting> (protocol);
268  if (lrp != 0)
269  {
270  for (uint32_t i = 0; i < lrp->GetNRoutingProtocols (); i++)
271  {
272  int16_t priority;
273  ret = GetRouting<T> (lrp->GetRoutingProtocol (i, priority)); // potential recursion, if inside ListRouting is ListRouting
274  if (ret != 0)
275  break;
276  }
277  }
278  }
279 
280  return ret;
281 }
282 
283 } // namespace ns3
284 
285 
286 #endif /* IPV4_ROUTING_HELPER_H */
static void PrintNeighborCacheAllAt(Time printTime, Ptr< OutputStreamWrapper > stream)
prints the neighbor cache of all nodes at a particular time.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
static void PrintNeighborCacheAllEvery(Time printInterval, Ptr< OutputStreamWrapper > stream)
prints the neighbor cache of all nodes at regular intervals specified by user.
static Ptr< T > GetRouting(Ptr< Ipv4RoutingProtocol > protocol)
Request a specified routing protocol <T> from Ipv4RoutingProtocol protocol.
virtual Ipv4RoutingHelper * Copy(void) const =0
virtual constructor
static void PrintNeighborCacheEvery(Time printInterval, Ptr< Node > node, Ptr< OutputStreamWrapper > stream)
prints the neighbor cache of a node at regular intervals specified by user.
static void PrintEvery(Time printInterval, Ptr< Node > node, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the routing tables of a node at regular intervals specified by user.
static void PrintRoutingTableAt(Time printTime, Ptr< Node > node, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the routing tables of a node at a particular time.
static void PrintRoutingTableEvery(Time printInterval, Ptr< Node > node, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the routing tables of a node at regular intervals specified by user.
Unit
The unit to use to interpret a number representing time.
Definition: nstime.h:108
a factory to create ns3::Ipv4RoutingProtocol objects
static void PrintArpCacheEvery(Time printInterval, Ptr< Node > node, Ptr< OutputStreamWrapper > stream)
prints the neighbor cache of a node at regular intervals specified by user.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
static void PrintRoutingTableAllEvery(Time printInterval, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the routing tables of all nodes at regular intervals specified by user.
static void PrintArpCache(Ptr< Node > node, Ptr< OutputStreamWrapper > stream)
prints the neighbor cache of a node.
virtual Ptr< Ipv4RoutingProtocol > Create(Ptr< Node > node) const =0
static void Print(Ptr< Node > node, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the routing tables of a node.
second
Definition: nstime.h:114
static void PrintRoutingTableAllAt(Time printTime, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the routing tables of all nodes at a particular time.
static void PrintNeighborCacheAt(Time printTime, Ptr< Node > node, Ptr< OutputStreamWrapper > stream)
prints the neighbor cache of a node at a particular time.