A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
ipv4-global-routing-helper.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2008 INRIA
3
*
4
* This program is free software; you can redistribute it and/or modify
5
* it under the terms of the GNU General Public License version 2 as
6
* published by the Free Software Foundation;
7
*
8
* This program is distributed in the hope that it will be useful,
9
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
* GNU General Public License for more details.
12
*
13
* You should have received a copy of the GNU General Public License
14
* along with this program; if not, write to the Free Software
15
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
*
17
* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
18
*/
19
#ifndef IPV4_GLOBAL_ROUTING_HELPER_H
20
#define IPV4_GLOBAL_ROUTING_HELPER_H
21
22
#include "
ipv4-routing-helper.h
"
23
24
#include "ns3/node-container.h"
25
26
namespace
ns3
27
{
28
29
/**
30
* \ingroup ipv4Helpers
31
*
32
* \brief Helper class that adds ns3::Ipv4GlobalRouting objects
33
*/
34
class
Ipv4GlobalRoutingHelper
:
public
Ipv4RoutingHelper
35
{
36
public
:
37
/**
38
* \brief Construct a GlobalRoutingHelper to make life easier for managing
39
* global routing tasks.
40
*/
41
Ipv4GlobalRoutingHelper
();
42
43
/**
44
* \brief Construct a GlobalRoutingHelper from another previously initialized
45
* instance (Copy Constructor).
46
* \param o object to be copied
47
*/
48
Ipv4GlobalRoutingHelper
(
const
Ipv4GlobalRoutingHelper
& o);
49
50
// Delete assignment operator to avoid misuse
51
Ipv4GlobalRoutingHelper
&
operator=
(
const
Ipv4GlobalRoutingHelper
&) =
delete
;
52
53
/**
54
* \returns pointer to clone of this Ipv4GlobalRoutingHelper
55
*
56
* This method is mainly for internal use by the other helpers;
57
* clients are expected to free the dynamic memory allocated by this method
58
*/
59
Ipv4GlobalRoutingHelper
*
Copy
()
const override
;
60
61
/**
62
* \param node the node on which the routing protocol will run
63
* \returns a newly-created routing protocol
64
*
65
* This method will be called by ns3::InternetStackHelper::Install
66
*/
67
Ptr<Ipv4RoutingProtocol>
Create
(
Ptr<Node>
node)
const override
;
68
69
/**
70
* \brief Build a routing database and initialize the routing tables of
71
* the nodes in the simulation. Makes all nodes in the simulation into
72
* routers.
73
*
74
* All this function does is call the functions
75
* BuildGlobalRoutingDatabase () and InitializeRoutes ().
76
*
77
*/
78
static
void
PopulateRoutingTables
();
79
/**
80
* \brief Remove all routes that were previously installed in a prior call
81
* to either PopulateRoutingTables() or RecomputeRoutingTables(), and
82
* add a new set of routes.
83
*
84
* This method does not change the set of nodes
85
* over which GlobalRouting is being used, but it will dynamically update
86
* its representation of the global topology before recomputing routes.
87
* Users must first call PopulateRoutingTables() and then may subsequently
88
* call RecomputeRoutingTables() at any later time in the simulation.
89
*
90
*/
91
static
void
RecomputeRoutingTables
();
92
};
93
94
}
// namespace ns3
95
96
#endif
/* IPV4_GLOBAL_ROUTING_HELPER_H */
ns3::Ipv4GlobalRoutingHelper
Helper class that adds ns3::Ipv4GlobalRouting objects.
Definition:
ipv4-global-routing-helper.h:35
ns3::Ipv4GlobalRoutingHelper::PopulateRoutingTables
static void PopulateRoutingTables()
Build a routing database and initialize the routing tables of the nodes in the simulation.
Definition:
ipv4-global-routing-helper.cc:61
ns3::Ipv4GlobalRoutingHelper::operator=
Ipv4GlobalRoutingHelper & operator=(const Ipv4GlobalRoutingHelper &)=delete
ns3::Ipv4GlobalRoutingHelper::RecomputeRoutingTables
static void RecomputeRoutingTables()
Remove all routes that were previously installed in a prior call to either PopulateRoutingTables() or...
Definition:
ipv4-global-routing-helper.cc:68
ns3::Ipv4GlobalRoutingHelper::Create
Ptr< Ipv4RoutingProtocol > Create(Ptr< Node > node) const override
Definition:
ipv4-global-routing-helper.cc:46
ns3::Ipv4GlobalRoutingHelper::Ipv4GlobalRoutingHelper
Ipv4GlobalRoutingHelper()
Construct a GlobalRoutingHelper to make life easier for managing global routing tasks.
Definition:
ipv4-global-routing-helper.cc:31
ns3::Ipv4GlobalRoutingHelper::Copy
Ipv4GlobalRoutingHelper * Copy() const override
Definition:
ipv4-global-routing-helper.cc:40
ns3::Ipv4RoutingHelper
a factory to create ns3::Ipv4RoutingProtocol objects
Definition:
ipv4-routing-helper.h:46
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:77
ipv4-routing-helper.h
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
internet
helper
ipv4-global-routing-helper.h
Generated on Tue May 28 2024 23:35:37 for ns-3 by
1.9.6