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-list-routing-helper.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2008 INRIA
3
*
4
* SPDX-License-Identifier: GPL-2.0-only
5
*
6
* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
7
*/
8
#ifndef IPV4_LIST_ROUTING_HELPER_H
9
#define IPV4_LIST_ROUTING_HELPER_H
10
11
#include "
ipv4-routing-helper.h
"
12
13
#include <list>
14
#include <stdint.h>
15
16
namespace
ns3
17
{
18
19
/**
20
* @ingroup ipv4Helpers
21
*
22
* @brief Helper class that adds ns3::Ipv4ListRouting objects
23
*
24
* This class is expected to be used in conjunction with
25
* ns3::InternetStackHelper::SetRoutingHelper
26
*/
27
class
Ipv4ListRoutingHelper
:
public
Ipv4RoutingHelper
28
{
29
public
:
30
/*
31
* Construct an Ipv4ListRoutingHelper used to make installing routing
32
* protocols easier.
33
*/
34
Ipv4ListRoutingHelper
();
35
36
/*
37
* Destroy an Ipv4ListRoutingHelper.
38
*/
39
~Ipv4ListRoutingHelper
()
override
;
40
41
/**
42
* @brief Construct an Ipv4ListRoutingHelper from another previously
43
* initialized instance (Copy Constructor).
44
* @param o object to be copied
45
*/
46
Ipv4ListRoutingHelper
(
const
Ipv4ListRoutingHelper
& o);
47
48
// Delete assignment operator to avoid misuse
49
Ipv4ListRoutingHelper
&
operator=
(
const
Ipv4ListRoutingHelper
&) =
delete
;
50
51
/**
52
* @returns pointer to clone of this Ipv4ListRoutingHelper
53
*
54
* This method is mainly for internal use by the other helpers;
55
* clients are expected to free the dynamic memory allocated by this method
56
*/
57
Ipv4ListRoutingHelper
*
Copy
()
const override
;
58
59
/**
60
* @param routing a routing helper
61
* @param priority the priority of the associated helper
62
*
63
* Store in the internal list a reference to the input routing helper
64
* and associated priority. These helpers will be used later by
65
* the ns3::Ipv4ListRoutingHelper::Create method to create
66
* an ns3::Ipv4ListRouting object and add in it routing protocols
67
* created with the helpers.
68
*/
69
void
Add
(
const
Ipv4RoutingHelper
& routing, int16_t priority);
70
/**
71
* @param node the node on which the routing protocol will run
72
* @returns a newly-created routing protocol
73
*
74
* This method will be called by ns3::InternetStackHelper::Install
75
*/
76
Ptr<Ipv4RoutingProtocol>
Create
(
Ptr<Node>
node)
const override
;
77
78
private
:
79
/**
80
* @brief Container for pairs of Ipv4RoutingHelper pointer / priority.
81
*/
82
std::list<std::pair<const Ipv4RoutingHelper*, int16_t>>
m_list
;
83
};
84
85
}
// namespace ns3
86
87
#endif
/* IPV4_LIST_ROUTING_HELPER_H */
ns3::Ipv4ListRoutingHelper
Helper class that adds ns3::Ipv4ListRouting objects.
Definition
ipv4-list-routing-helper.h:28
ns3::Ipv4ListRoutingHelper::Copy
Ipv4ListRoutingHelper * Copy() const override
Definition
ipv4-list-routing-helper.cc:37
ns3::Ipv4ListRoutingHelper::Ipv4ListRoutingHelper
Ipv4ListRoutingHelper()
Definition
ipv4-list-routing-helper.cc:16
ns3::Ipv4ListRoutingHelper::~Ipv4ListRoutingHelper
~Ipv4ListRoutingHelper() override
Definition
ipv4-list-routing-helper.cc:20
ns3::Ipv4ListRoutingHelper::Create
Ptr< Ipv4RoutingProtocol > Create(Ptr< Node > node) const override
Definition
ipv4-list-routing-helper.cc:49
ns3::Ipv4ListRoutingHelper::Add
void Add(const Ipv4RoutingHelper &routing, int16_t priority)
Definition
ipv4-list-routing-helper.cc:43
ns3::Ipv4ListRoutingHelper::operator=
Ipv4ListRoutingHelper & operator=(const Ipv4ListRoutingHelper &)=delete
ns3::Ipv4ListRoutingHelper::m_list
std::list< std::pair< const Ipv4RoutingHelper *, int16_t > > m_list
Container for pairs of Ipv4RoutingHelper pointer / priority.
Definition
ipv4-list-routing-helper.h:82
ns3::Ipv4RoutingHelper
a factory to create ns3::Ipv4RoutingProtocol objects
Definition
ipv4-routing-helper.h:35
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition
mpi-test-fixtures.h:37
ipv4-routing-helper.h
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
internet
helper
ipv4-list-routing-helper.h
Generated on Thu Dec 5 2024 18:20:42 for ns-3 by
1.11.0