A Discrete-Event Network Simulator
API
internet-stack-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 
20 #ifndef INTERNET_STACK_HELPER_H
21 #define INTERNET_STACK_HELPER_H
22 
23 #include "internet-trace-helper.h"
24 
25 #include "ns3/ipv4-l3-protocol.h"
26 #include "ns3/ipv6-l3-protocol.h"
27 #include "ns3/net-device-container.h"
28 #include "ns3/node-container.h"
29 #include "ns3/object-factory.h"
30 #include "ns3/packet.h"
31 #include "ns3/ptr.h"
32 
33 namespace ns3
34 {
35 
36 class Node;
37 class Ipv4RoutingHelper;
38 class Ipv6RoutingHelper;
39 
89  public PcapHelperForIpv6,
92 {
93  public:
104 
108  ~InternetStackHelper() override;
109 
115 
122 
126  void Reset();
127 
137  void SetRoutingHelper(const Ipv4RoutingHelper& routing);
138 
143  void SetRoutingHelper(const Ipv6RoutingHelper& routing);
144 
152  void Install(std::string nodeName) const;
153 
161  void Install(Ptr<Node> node) const;
162 
171  void Install(NodeContainer c) const;
172 
176  void InstallAll() const;
177 
182  void SetIpv4StackInstall(bool enable);
183 
188  void SetIpv6StackInstall(bool enable);
189 
194  void SetIpv4ArpJitter(bool enable);
195 
200  void SetIpv6NsRsJitter(bool enable);
201 
213  int64_t AssignStreams(NodeContainer c, int64_t stream);
214 
215  private:
224  void EnablePcapIpv4Internal(std::string prefix,
225  Ptr<Ipv4> ipv4,
226  uint32_t interface,
227  bool explicitFilename) override;
228 
240  std::string prefix,
241  Ptr<Ipv4> ipv4,
242  uint32_t interface,
243  bool explicitFilename) override;
244 
253  void EnablePcapIpv6Internal(std::string prefix,
254  Ptr<Ipv6> ipv6,
255  uint32_t interface,
256  bool explicitFilename) override;
257 
269  std::string prefix,
270  Ptr<Ipv6> ipv6,
271  uint32_t interface,
272  bool explicitFilename) override;
273 
277  void Initialize();
278 
283 
288 
295  static void CreateAndAggregateObjectFromTypeId(Ptr<Node> node, const std::string typeId);
296 
302  bool PcapHooked(Ptr<Ipv4> ipv4);
303 
309  bool AsciiHooked(Ptr<Ipv4> ipv4);
310 
316  bool PcapHooked(Ptr<Ipv6> ipv6);
317 
323  bool AsciiHooked(Ptr<Ipv6> ipv6);
324 
329 
334 
339 
344 };
345 
346 } // namespace ns3
347 
348 #endif /* INTERNET_STACK_HELPER_H */
Base class providing common user-level ascii trace operations for helpers representing IPv4 protocols...
Base class providing common user-level ascii trace operations for helpers representing IPv6 protocols...
aggregate IP/TCP/UDP functionality to existing Nodes.
void EnablePcapIpv6Internal(std::string prefix, Ptr< Ipv6 > ipv6, uint32_t interface, bool explicitFilename) override
Enable pcap output the indicated Ipv6 and interface pair.
void SetIpv4StackInstall(bool enable)
Enable/disable IPv4 stack install.
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
void SetIpv4ArpJitter(bool enable)
Enable/disable IPv4 ARP Jitter.
void EnableAsciiIpv4Internal(Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< Ipv4 > ipv4, uint32_t interface, bool explicitFilename) override
Enable ascii trace output on the indicated Ipv4 and interface pair.
bool m_ipv6Enabled
IPv6 install state (enabled/disabled) ?
void SetRoutingHelper(const Ipv4RoutingHelper &routing)
bool m_ipv6NsRsJitterEnabled
IPv6 IPv6 NS and RS Jitter state (enabled/disabled) ?
bool AsciiHooked(Ptr< Ipv4 > ipv4)
checks if there is an hook to an ascii output stream
bool m_ipv4Enabled
IPv4 install state (enabled/disabled) ?
const Ipv4RoutingHelper * m_routing
IPv4 routing helper.
void InstallAll() const
Aggregate IPv4, IPv6, UDP, and TCP stacks to all nodes in the simulation.
void SetIpv6StackInstall(bool enable)
Enable/disable IPv6 stack install.
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
static void CreateAndAggregateObjectFromTypeId(Ptr< Node > node, const std::string typeId)
create an object from its TypeId and aggregates it to the node.
void Initialize()
Initialize the helper to its default values.
void SetIpv6NsRsJitter(bool enable)
Enable/disable IPv6 NS and RS Jitter.
bool PcapHooked(Ptr< Ipv4 > ipv4)
checks if there is an hook to a Pcap wrapper
void EnablePcapIpv4Internal(std::string prefix, Ptr< Ipv4 > ipv4, uint32_t interface, bool explicitFilename) override
Enable pcap output the indicated Ipv4 and interface pair.
bool m_ipv4ArpJitterEnabled
IPv4 ARP Jitter state (enabled/disabled) ?
const Ipv6RoutingHelper * m_routingv6
IPv6 routing helper.
InternetStackHelper & operator=(const InternetStackHelper &o)
Copy constructor.
InternetStackHelper()
Create a new InternetStackHelper which uses a mix of static routing and global routing by default.
void Reset()
Return helper internal state to that of a newly constructed one.
~InternetStackHelper() override
Destroy the InternetStackHelper.
void EnableAsciiIpv6Internal(Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< Ipv6 > ipv6, uint32_t interface, bool explicitFilename) override
Enable ascii trace output on the indicated Ipv6 and interface pair.
a factory to create ns3::Ipv4RoutingProtocol objects
A factory to create ns3::Ipv6RoutingProtocol objects.
keep track of a set of node pointers.
Base class providing common user-level pcap operations for helpers representing IPv4 protocols .
Base class providing common user-level pcap operations for helpers representing IPv6 protocols .
Every class exported by the ns3 library is enclosed in the ns3 namespace.