aggregate IP/TCP/UDP functionality to existing Nodes. More...

#include "internet-stack-helper.h"

Inheritance diagram for ns3::InternetStackHelper:

Collaboration diagram for ns3::InternetStackHelper:

Public Member Functions
	InternetStackHelper ()
	Create a new InternetStackHelper which uses a mix of static routing and global routing by default.

	InternetStackHelper (const InternetStackHelper &o)
	Copy constructor.

	~InternetStackHelper () override
	Destroy the InternetStackHelper.

int64_t	AssignStreams (NodeContainer c, int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model.

void	Install (NodeContainer c) const
	For each node in the input container, aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and, ns3::Tcp classes.

void	Install (Ptr< Node > node) const
	Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provided node.

void	Install (std::string nodeName) const
	Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provided node.

void	InstallAll () const
	Aggregate IPv4, IPv6, UDP, and TCP stacks to all nodes in the simulation.

InternetStackHelper &	operator= (const InternetStackHelper &o)
	Copy constructor.

void	Reset ()
	Return helper internal state to that of a newly constructed one.

void	SetIpv4ArpJitter (bool enable)
	Enable/disable IPv4 ARP Jitter.

void	SetIpv4StackInstall (bool enable)
	Enable/disable IPv4 stack install.

void	SetIpv6NsRsJitter (bool enable)
	Enable/disable IPv6 NS and RS Jitter.

void	SetIpv6StackInstall (bool enable)
	Enable/disable IPv6 stack install.

void	SetRoutingHelper (const Ipv4RoutingHelper &routing)

void	SetRoutingHelper (const Ipv6RoutingHelper &routing)
	Set IPv6 routing helper.

Public Member Functions inherited from ns3::PcapHelperForIpv4
	PcapHelperForIpv4 ()
	Construct a PcapHelperForIpv4.

virtual	~PcapHelperForIpv4 ()
	Destroy a PcapHelperForIpv4.

void	EnablePcapIpv4 (std::string prefix, Ipv4InterfaceContainer c)
	Enable pcap output on each Ipv4 and interface pair in the container.

void	EnablePcapIpv4 (std::string prefix, NodeContainer n)
	Enable pcap output on all Ipv4 and interface pairs existing in the nodes provided in the container.

void	EnablePcapIpv4 (std::string prefix, Ptr< Ipv4 > ipv4, uint32_t interface, bool explicitFilename=false)
	Enable pcap output the indicated Ipv4 and interface pair.

void	EnablePcapIpv4 (std::string prefix, std::string ipv4Name, uint32_t interface, bool explicitFilename=false)
	Enable pcap output the indicated Ipv4 and interface pair using a Ptr<Ipv4> previously named using the ns-3 object name service.

void	EnablePcapIpv4 (std::string prefix, uint32_t nodeid, uint32_t interface, bool explicitFilename)
	Enable pcap output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface.

void	EnablePcapIpv4All (std::string prefix)
	Enable pcap output on all Ipv4 and interface pairs existing in the set of all nodes created in the simulation.

virtual void	EnablePcapIpv4Internal (std::string prefix, Ptr< Ipv4 > ipv4, uint32_t interface, bool explicitFilename)=0
	Enable pcap output the indicated Ipv4 and interface pair.

Public Member Functions inherited from ns3::PcapHelperForIpv6
	PcapHelperForIpv6 ()
	Construct a PcapHelperForIpv6.

virtual	~PcapHelperForIpv6 ()
	Destroy a PcapHelperForIpv6.

void	EnablePcapIpv6 (std::string prefix, Ipv6InterfaceContainer c)
	Enable pcap output on each Ipv6 and interface pair in the container.

void	EnablePcapIpv6 (std::string prefix, NodeContainer n)
	Enable pcap output on all Ipv6 and interface pairs existing in the nodes provided in the container.

void	EnablePcapIpv6 (std::string prefix, Ptr< Ipv6 > ipv6, uint32_t interface, bool explicitFilename=false)
	Enable pcap output the indicated Ipv6 and interface pair.

void	EnablePcapIpv6 (std::string prefix, std::string ipv6Name, uint32_t interface, bool explicitFilename=false)
	Enable pcap output the indicated Ipv6 and interface pair using a Ptr<Ipv6> previously named using the ns-3 object name service.

void	EnablePcapIpv6 (std::string prefix, uint32_t nodeid, uint32_t interface, bool explicitFilename)
	Enable pcap output on the Ipv6 and interface pair specified by a global node-id (of a previously created node) and interface.

void	EnablePcapIpv6All (std::string prefix)
	Enable pcap output on all Ipv6 and interface pairs existing in the set of all nodes created in the simulation.

virtual void	EnablePcapIpv6Internal (std::string prefix, Ptr< Ipv6 > ipv6, uint32_t interface, bool explicitFilename)=0
	Enable pcap output the indicated Ipv6 and interface pair.

Public Member Functions inherited from ns3::AsciiTraceHelperForIpv4
	AsciiTraceHelperForIpv4 ()
	Construct an AsciiTraceHelperForIpv4.

virtual	~AsciiTraceHelperForIpv4 ()
	Destroy an AsciiTraceHelperForIpv4.

void	EnableAsciiIpv4 (Ptr< OutputStreamWrapper > stream, Ipv4InterfaceContainer c)
	Enable ascii trace output on each device in the container which is of the appropriate type.

void	EnableAsciiIpv4 (Ptr< OutputStreamWrapper > stream, NodeContainer n)
	Enable ascii trace output on all Ipv4 and interface pairs existing in the nodes provided in the container.

void	EnableAsciiIpv4 (Ptr< OutputStreamWrapper > stream, Ptr< Ipv4 > ipv4, uint32_t interface)
	Enable ascii trace output on the indicated Ipv4 and interface pair.

void	EnableAsciiIpv4 (Ptr< OutputStreamWrapper > stream, std::string ipv4Name, uint32_t interface)
	Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service.

void	EnableAsciiIpv4 (Ptr< OutputStreamWrapper > stream, uint32_t nodeid, uint32_t interface, bool explicitFilename)
	Enable ascii trace output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface.

void	EnableAsciiIpv4 (std::string prefix, Ipv4InterfaceContainer c)
	Enable ascii trace output on each Ipv4 and interface pair in the container.

void	EnableAsciiIpv4 (std::string prefix, NodeContainer n)
	Enable ascii trace output on all Ipv4 and interface pairs existing in the nodes provided in the container.

void	EnableAsciiIpv4 (std::string prefix, Ptr< Ipv4 > ipv4, uint32_t interface, bool explicitFilename=false)
	Enable ascii trace output on the indicated Ipv4 and interface pair.

void	EnableAsciiIpv4 (std::string prefix, std::string ipv4Name, uint32_t interface, bool explicitFilename=false)
	Enable ascii trace output the indicated Ipv4 and interface pair using an Ipv4 previously named using the ns-3 object name service.

void	EnableAsciiIpv4 (std::string prefix, uint32_t nodeid, uint32_t deviceid, bool explicitFilename)
	Enable ascii trace output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface.

void	EnableAsciiIpv4All (Ptr< OutputStreamWrapper > stream)
	Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes created in the simulation.

void	EnableAsciiIpv4All (std::string prefix)
	Enable ascii trace output on all Ipv4 and interface pairs existing in the set of all nodes created in the simulation.

virtual void	EnableAsciiIpv4Internal (Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< Ipv4 > ipv4, uint32_t interface, bool explicitFilename)=0
	Enable ascii trace output on the indicated Ipv4 and interface pair.

Public Member Functions inherited from ns3::AsciiTraceHelperForIpv6
	AsciiTraceHelperForIpv6 ()
	Construct an AsciiTraceHelperForIpv6.

virtual	~AsciiTraceHelperForIpv6 ()
	Destroy an AsciiTraceHelperForIpv6.

void	EnableAsciiIpv6 (Ptr< OutputStreamWrapper > stream, Ipv6InterfaceContainer c)
	Enable ascii trace output on each device in the container which is of the appropriate type.

void	EnableAsciiIpv6 (Ptr< OutputStreamWrapper > stream, NodeContainer n)
	Enable ascii trace output on all Ipv6 and interface pairs existing in the nodes provided in the container.

void	EnableAsciiIpv6 (Ptr< OutputStreamWrapper > stream, Ptr< Ipv6 > ipv6, uint32_t interface)
	Enable ascii trace output on the indicated Ipv6 and interface pair.

void	EnableAsciiIpv6 (Ptr< OutputStreamWrapper > stream, std::string ipv6Name, uint32_t interface)
	Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service.

void	EnableAsciiIpv6 (Ptr< OutputStreamWrapper > stream, uint32_t nodeid, uint32_t interface)
	Enable ascii trace output on the Ipv6 and interface pair specified by a global node-id (of a previously created node) and interface.

void	EnableAsciiIpv6 (std::string prefix, Ipv6InterfaceContainer c)
	Enable ascii trace output on each Ipv6 and interface pair in the container.

void	EnableAsciiIpv6 (std::string prefix, NodeContainer n)
	Enable ascii trace output on all Ipv6 and interface pairs existing in the nodes provided in the container.

void	EnableAsciiIpv6 (std::string prefix, Ptr< Ipv6 > ipv6, uint32_t interface, bool explicitFilename=false)
	Enable ascii trace output on the indicated Ipv6 and interface pair.

void	EnableAsciiIpv6 (std::string prefix, std::string ipv6Name, uint32_t interface, bool explicitFilename=false)
	Enable ascii trace output the indicated Ipv6 and interface pair using an Ipv6 previously named using the ns-3 object name service.

void	EnableAsciiIpv6 (std::string prefix, uint32_t nodeid, uint32_t interface, bool explicitFilename)
	Enable ascii trace output on the Ipv6 and interface pair specified by a global node-id (of a previously created node) and interface.

void	EnableAsciiIpv6All (Ptr< OutputStreamWrapper > stream)
	Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes created in the simulation.

void	EnableAsciiIpv6All (std::string prefix)
	Enable ascii trace output on all Ipv6 and interface pairs existing in the set of all nodes created in the simulation.

virtual void	EnableAsciiIpv6Internal (Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< Ipv6 > ipv6, uint32_t interface, bool explicitFilename)=0
	Enable ascii trace output on the indicated Ipv6 and interface pair.

Private Member Functions
bool	AsciiHooked (Ptr< Ipv4 > ipv4)
	checks if there is an hook to an ascii output stream

bool	AsciiHooked (Ptr< Ipv6 > ipv6)
	checks if there is an hook to an ascii output stream

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.

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.

void	EnablePcapIpv4Internal (std::string prefix, Ptr< Ipv4 > ipv4, uint32_t interface, bool explicitFilename) override
	Enable pcap output the indicated Ipv4 and interface pair.

void	EnablePcapIpv6Internal (std::string prefix, Ptr< Ipv6 > ipv6, uint32_t interface, bool explicitFilename) override
	Enable pcap output the indicated Ipv6 and interface pair.

void	Initialize ()
	Initialize the helper to its default values.

bool	PcapHooked (Ptr< Ipv4 > ipv4)
	checks if there is an hook to a Pcap wrapper

bool	PcapHooked (Ptr< Ipv6 > ipv6)
	checks if there is an hook to a Pcap wrapper

Static Private Member Functions
static void	CreateAndAggregateObjectFromTypeId (Ptr< Node > node, const std::string typeId)
	create an object from its TypeId and aggregates it to the node.

Private Attributes
bool	m_ipv4ArpJitterEnabled
	IPv4 ARP Jitter state (enabled/disabled) ?

bool	m_ipv4Enabled
	IPv4 install state (enabled/disabled) ?

bool	m_ipv6Enabled
	IPv6 install state (enabled/disabled) ?

bool	m_ipv6NsRsJitterEnabled
	IPv6 IPv6 NS and RS Jitter state (enabled/disabled) ?

const Ipv4RoutingHelper *	m_routing
	IPv4 routing helper.

const Ipv6RoutingHelper *	m_routingv6
	IPv6 routing helper.

Detailed Description

aggregate IP/TCP/UDP functionality to existing Nodes.

This helper enables pcap and ascii tracing of events in the internet stack associated with a node. This is substantially similar to the tracing that happens in device helpers, but the important difference is that, well, there is no device. This means that the creation of output file names will change, and also the user-visible methods will not reference devices and therefore the number of trace enable methods is reduced.

Normally we avoid multiple inheritance in ns-3, however, the classes PcapUserHelperForIpv4 and AsciiTraceUserHelperForIpv4 are treated as "mixins". A mixin is a self-contained class that encapsulates a general attribute or a set of functionality that may be of interest to many other classes.

This class aggregates instances of these objects, by default, to each node:

ns3::ArpL3Protocol
ns3::Ipv4L3Protocol
ns3::Icmpv4L4Protocol
ns3::Ipv6L3Protocol
ns3::Icmpv6L4Protocol
ns3::UdpL4Protocol
ns3::TrafficControlLayer
a TCP based on the TCP factory provided
a PacketSocketFactory
Ipv4 routing (a list routing object, a global routing object, and a static routing object)
Ipv6 routing (a static routing object)

Definition at line 88 of file internet-stack-helper.h.

Constructor & Destructor Documentation

◆ InternetStackHelper() [1/2]

ns3::InternetStackHelper::InternetStackHelper ( )

Create a new InternetStackHelper which uses a mix of static routing and global routing by default.

The static routing protocol (ns3::Ipv4StaticRouting) and the global routing protocol are stored in an ns3::Ipv4ListRouting protocol with priorities 0, and -10 by default. If you wish to use different priorites and different routing protocols, you need to use an adhoc ns3::Ipv4RoutingHelper, such as ns3::OlsrHelper

Definition at line 116 of file internet-stack-helper.cc.

References Initialize().

Here is the call graph for this function:

◆ ~InternetStackHelper()

ns3::InternetStackHelper::~InternetStackHelper ( )

override

Destroy the InternetStackHelper.

Definition at line 142 of file internet-stack-helper.cc.

References m_routing, and m_routingv6.

◆ InternetStackHelper() [2/2]

ns3::InternetStackHelper::InternetStackHelper ( const InternetStackHelper & o )

Copy constructor.

Parameters

o	Object to copy from.

Definition at line 148 of file internet-stack-helper.cc.

References ns3::Ipv4RoutingHelper::Copy(), ns3::Ipv6RoutingHelper::Copy(), m_ipv4ArpJitterEnabled, m_ipv4Enabled, m_ipv6Enabled, m_ipv6NsRsJitterEnabled, m_routing, and m_routingv6.

Here is the call graph for this function:

Member Function Documentation

◆ AsciiHooked() [1/2]

bool ns3::InternetStackHelper::AsciiHooked ( Ptr< Ipv4 > ipv4 )

private

checks if there is an hook to an ascii output stream

Parameters

ipv4	pointer to the IPv4 object

Returns: true if a hook is found

Definition at line 775 of file internet-stack-helper.cc.

References ns3::g_interfaceStreamMapIpv4.

Referenced by EnableAsciiIpv4Internal(), and EnableAsciiIpv6Internal().

Here is the caller graph for this function:

◆ AsciiHooked() [2/2]

bool ns3::InternetStackHelper::AsciiHooked ( Ptr< Ipv6 > ipv6 )

private

checks if there is an hook to an ascii output stream

Parameters

ipv6	pointer to the IPv6 object

Returns: true if a hook is found

Definition at line 1119 of file internet-stack-helper.cc.

References ns3::g_interfaceStreamMapIpv6.

◆ AssignStreams()

int64_t ns3::InternetStackHelper::AssignStreams	(	NodeContainer	c,
		int64_t	stream
	)

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned. The Install() method should have previously been called by the user.

Parameters

stream	first stream index to use
c	NodeContainer of the set of nodes for which the internet models should be modified to use a fixed stream

Returns: the number of stream indices assigned by this helper

Definition at line 223 of file internet-stack-helper.cc.

References ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), ns3::Ipv6ExtensionFragment::EXT_NUMBER, and NS_ASSERT.

Referenced by ChainRegressionTest::CreateDevices(), Bug772ChainTest::CreateDevices(), HwmpProactiveRegressionTest::CreateDevices(), HwmpReactiveRegressionTest::CreateDevices(), HwmpSimplestRegressionTest::CreateDevices(), HwmpDoRfRegressionTest::CreateDevices(), and FlameRegressionTest::CreateDevices().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateAndAggregateObjectFromTypeId()

void ns3::InternetStackHelper::CreateAndAggregateObjectFromTypeId	(	Ptr< Node >	node,
		const std::string	typeId
	)

staticprivate

create an object from its TypeId and aggregates it to the node.

Does nothing if an object of the same type is already aggregated to the node.

Parameters

node	the node
typeId	the object TypeId

Definition at line 283 of file internet-stack-helper.cc.

References ns3::ObjectFactory::Create(), ns3::TypeId::LookupByName(), and ns3::ObjectFactory::SetTypeId().

Referenced by Install().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnableAsciiIpv4Internal()

void ns3::InternetStackHelper::EnableAsciiIpv4Internal	(	Ptr< OutputStreamWrapper >	stream,
		std::string	prefix,
		Ptr< Ipv4 >	ipv4,
		uint32_t	interface,
		bool	explicitFilename
	)

overrideprivatevirtual

Enable ascii trace output on the indicated Ipv4 and interface pair.

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
prefix	Filename prefix to use for ascii trace files.
ipv4	Ptr to the Ipv4 interface on which you want to enable tracing.
interface	Interface ID on the Ipv4 on which you want to enable tracing.
explicitFilename	Treat the prefix as an explicit filename if true

Implements ns3::AsciiTraceHelperForIpv4.

Definition at line 790 of file internet-stack-helper.cc.

References AsciiHooked(), ns3::Config::Connect(), ns3::AsciiTraceHelper::CreateFileStream(), ns3::AsciiTraceHelper::DefaultDropSinkWithContext(), ns3::Packet::EnablePrinting(), ns3::g_interfaceStreamMapIpv4, ns3::AsciiTraceHelper::GetFilenameFromInterfacePair(), ns3::Node::GetId(), ns3::AsciiTraceHelper::HookDefaultDropSinkWithoutContext(), ns3::Ipv4L3ProtocolDropSinkWithContext(), ns3::Ipv4L3ProtocolDropSinkWithoutContext(), ns3::Ipv4L3ProtocolRxSinkWithContext(), ns3::Ipv4L3ProtocolRxSinkWithoutContext(), ns3::Ipv4L3ProtocolTxSinkWithContext(), ns3::Ipv4L3ProtocolTxSinkWithoutContext(), m_ipv4Enabled, ns3::MakeBoundCallback(), NS_ASSERT_MSG, NS_LOG_INFO, and ns3::ObjectBase::TraceConnectWithoutContext().

Here is the call graph for this function:

◆ EnableAsciiIpv6Internal()

void ns3::InternetStackHelper::EnableAsciiIpv6Internal	(	Ptr< OutputStreamWrapper >	stream,
		std::string	prefix,
		Ptr< Ipv6 >	ipv6,
		uint32_t	interface,
		bool	explicitFilename
	)

overrideprivatevirtual

Enable ascii trace output on the indicated Ipv6 and interface pair.

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
prefix	Filename prefix to use for ascii trace files.
ipv6	Ptr to the Ipv6 interface on which you want to enable tracing.
interface	Interface ID on the Ipv6 on which you want to enable tracing.
explicitFilename	Treat the prefix as an explicit filename if true

Implements ns3::AsciiTraceHelperForIpv6.

Definition at line 1134 of file internet-stack-helper.cc.

References AsciiHooked(), ns3::Config::Connect(), ns3::AsciiTraceHelper::CreateFileStream(), ns3::Packet::EnablePrinting(), ns3::g_interfaceStreamMapIpv6, ns3::AsciiTraceHelper::GetFilenameFromInterfacePair(), ns3::Node::GetId(), ns3::Ipv6L3ProtocolDropSinkWithContext(), ns3::Ipv6L3ProtocolDropSinkWithoutContext(), ns3::Ipv6L3ProtocolRxSinkWithContext(), ns3::Ipv6L3ProtocolRxSinkWithoutContext(), ns3::Ipv6L3ProtocolTxSinkWithContext(), ns3::Ipv6L3ProtocolTxSinkWithoutContext(), m_ipv6Enabled, ns3::MakeBoundCallback(), NS_ASSERT_MSG, and NS_LOG_INFO.

Here is the call graph for this function:

◆ EnablePcapIpv4Internal()

void ns3::InternetStackHelper::EnablePcapIpv4Internal	(	std::string	prefix,
		Ptr< Ipv4 >	ipv4,
		uint32_t	interface,
		bool	explicitFilename
	)

overrideprivatevirtual

Enable pcap output the indicated Ipv4 and interface pair.

Parameters

prefix	Filename prefix to use for pcap files.
ipv4	Ptr to the Ipv4 interface on which you want to enable tracing.
interface	Interface ID on the Ipv4 on which you want to enable tracing.
explicitFilename	Treat the prefix as an explicit filename if true

Implements ns3::PcapHelperForIpv4.

Definition at line 420 of file internet-stack-helper.cc.

References ns3::PcapHelper::CreateFile(), ns3::PcapHelper::DLT_RAW, ns3::g_interfaceFileMapIpv4, ns3::PcapHelper::GetFilenameFromInterfacePair(), ns3::Node::GetId(), ns3::Ipv4L3ProtocolRxTxSink(), m_ipv4Enabled, ns3::MakeCallback(), NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, and PcapHooked().

Here is the call graph for this function:

◆ EnablePcapIpv6Internal()

void ns3::InternetStackHelper::EnablePcapIpv6Internal	(	std::string	prefix,
		Ptr< Ipv6 >	ipv6,
		uint32_t	interface,
		bool	explicitFilename
	)

overrideprivatevirtual

Enable pcap output the indicated Ipv6 and interface pair.

Parameters

prefix	Filename prefix to use for pcap files.
ipv6	Ptr to the Ipv6 interface on which you want to enable tracing.
interface	Interface ID on the Ipv6 on which you want to enable tracing.
explicitFilename	Treat the prefix as an explicit filename if true

Implements ns3::PcapHelperForIpv6.

Definition at line 526 of file internet-stack-helper.cc.

References ns3::PcapHelper::CreateFile(), ns3::PcapHelper::DLT_RAW, ns3::g_interfaceFileMapIpv6, ns3::PcapHelper::GetFilenameFromInterfacePair(), ns3::Node::GetId(), ns3::Ipv6L3ProtocolRxTxSink(), m_ipv6Enabled, ns3::MakeCallback(), NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, and PcapHooked().

Here is the call graph for this function:

◆ Initialize()

void ns3::InternetStackHelper::Initialize ( )

private

Initialize the helper to its default values.

Definition at line 130 of file internet-stack-helper.cc.

References ns3::Ipv4ListRoutingHelper::Add(), and SetRoutingHelper().

Referenced by InternetStackHelper(), and Reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Install() [1/3]

void ns3::InternetStackHelper::Install ( NodeContainer c ) const

For each node in the input container, aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and, ns3::Tcp classes.

This method will do nothing if the stacks are already installed, and will not overwrite existing stacks parameters.

Parameters

c	NodeContainer that holds the set of nodes on which to install the new stacks.

Definition at line 268 of file internet-stack-helper.cc.

References ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), and Install().

Here is the call graph for this function:

◆ Install() [2/3]

void ns3::InternetStackHelper::Install ( Ptr< Node > node ) const

Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provided node.

This method will do nothing if the stacks are already installed, and will not overwrite existing stacks parameters.

Parameters

node	The node on which to install the stack.

Definition at line 298 of file internet-stack-helper.cc.

References ns3::Ipv4RoutingHelper::Create(), ns3::Ipv6RoutingHelper::Create(), CreateAndAggregateObjectFromTypeId(), m_ipv4ArpJitterEnabled, m_ipv4Enabled, m_ipv6Enabled, m_ipv6NsRsJitterEnabled, m_routing, m_routingv6, and NS_ASSERT.

Here is the call graph for this function:

◆ Install() [3/3]

void ns3::InternetStackHelper::Install ( std::string nodeName ) const

Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provided node.

This method will do nothing if the stacks are already installed, and will not overwrite existing stacks parameters.

Parameters

nodeName The name of the node on which to install the stack.

Definition at line 370 of file internet-stack-helper.cc.

References Install().

Referenced by ChainRegressionTest::CreateDevices(), Bug772ChainTest::CreateDevices(), HwmpProactiveRegressionTest::CreateDevices(), HwmpReactiveRegressionTest::CreateDevices(), HwmpSimplestRegressionTest::CreateDevices(), HwmpDoRfRegressionTest::CreateDevices(), FlameRegressionTest::CreateDevices(), ThreeGppHttpObjectTestCase::CreateSimpleInternetNode(), ns3::aodv::LoopbackTestCase::DoRun(), DhcpTestCase::DoRun(), RadvdTestCase::DoRun(), Ipv4RipTest::DoRun(), Ipv4RipCountToInfinityTest::DoRun(), Ipv4RipSplitHorizonStrategyTest::DoRun(), Ipv6DadTest::DoRun(), IpAddressHelperTestCasev6::DoRun(), Ipv6ForwardingTest::DoRun(), Ipv6RawSocketImplTest::DoRun(), Ipv6RipngTest::DoRun(), Ipv6RipngCountToInfinityTest::DoRun(), Ipv6RipngSplitHorizonStrategyTest::DoRun(), DynamicNeighborCacheTest::DoRun(), Udp6SocketImplTest::DoRun(), LteHandoverDelayTestCase::DoRun(), LteHandoverFailureTestCase::DoRun(), SixlowpanIphcStatefulImplTest::DoRun(), CsmaPingTestCase::DoRun(), CsmaRawIpSocketTestCase::DoRun(), PingTestCase::DoSetup(), Install(), InstallAll(), MeshTest::InstallInternetStack(), and UanExperiment::SetupCommunications().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InstallAll()

void ns3::InternetStackHelper::InstallAll ( ) const

Aggregate IPv4, IPv6, UDP, and TCP stacks to all nodes in the simulation.

Definition at line 277 of file internet-stack-helper.cc.

References ns3::NodeContainer::GetGlobal(), and Install().

Here is the call graph for this function:

◆ operator=()

InternetStackHelper & ns3::InternetStackHelper::operator= ( const InternetStackHelper & o )

Copy constructor.

Parameters

o	Object to copy from.

Returns: A copy of the InternetStackHelper.

Definition at line 159 of file internet-stack-helper.cc.

References ns3::Ipv4RoutingHelper::Copy(), ns3::Ipv6RoutingHelper::Copy(), m_routing, and m_routingv6.

Here is the call graph for this function:

◆ PcapHooked() [1/2]

bool ns3::InternetStackHelper::PcapHooked ( Ptr< Ipv4 > ipv4 )

private

checks if there is an hook to a Pcap wrapper

Parameters

ipv4	pointer to the IPv4 object

Returns: true if a hook is found

Definition at line 405 of file internet-stack-helper.cc.

References ns3::g_interfaceFileMapIpv4.

Referenced by EnablePcapIpv4Internal(), and EnablePcapIpv6Internal().

Here is the caller graph for this function:

◆ PcapHooked() [2/2]

bool ns3::InternetStackHelper::PcapHooked ( Ptr< Ipv6 > ipv6 )

private

checks if there is an hook to a Pcap wrapper

Parameters

ipv6	pointer to the IPv6 object

Returns: true if a hook is found

Definition at line 511 of file internet-stack-helper.cc.

References ns3::g_interfaceFileMapIpv6.

◆ Reset()

void ns3::InternetStackHelper::Reset ( )

Return helper internal state to that of a newly constructed one.

Definition at line 171 of file internet-stack-helper.cc.

References Initialize(), m_ipv4ArpJitterEnabled, m_ipv4Enabled, m_ipv6Enabled, m_ipv6NsRsJitterEnabled, m_routing, and m_routingv6.

Here is the call graph for this function:

◆ SetIpv4ArpJitter()

void ns3::InternetStackHelper::SetIpv4ArpJitter ( bool enable )

Enable/disable IPv4 ARP Jitter.

Parameters

enable enable state

Definition at line 211 of file internet-stack-helper.cc.

References m_ipv4ArpJitterEnabled.

◆ SetIpv4StackInstall()

void ns3::InternetStackHelper::SetIpv4StackInstall ( bool enable )

Enable/disable IPv4 stack install.

Parameters

enable enable state

Definition at line 199 of file internet-stack-helper.cc.

References m_ipv4Enabled.

Referenced by IpAddressHelperTestCasev6::DoRun(), and PingTestCase::DoSetup().

Here is the caller graph for this function:

◆ SetIpv6NsRsJitter()

void ns3::InternetStackHelper::SetIpv6NsRsJitter ( bool enable )

Enable/disable IPv6 NS and RS Jitter.

Parameters

enable enable state

Definition at line 217 of file internet-stack-helper.cc.

References m_ipv6NsRsJitterEnabled.

◆ SetIpv6StackInstall()

void ns3::InternetStackHelper::SetIpv6StackInstall ( bool enable )

Enable/disable IPv6 stack install.

Parameters

enable enable state

Definition at line 205 of file internet-stack-helper.cc.

References m_ipv6Enabled.

Referenced by PingTestCase::DoSetup().

Here is the caller graph for this function:

◆ SetRoutingHelper() [1/2]

void ns3::InternetStackHelper::SetRoutingHelper ( const Ipv4RoutingHelper & routing )

Parameters

routing a new routing helper

Set the routing helper to use during Install. The routing helper is really an object factory which is used to create an object of type ns3::Ipv4RoutingProtocol per node. This routing object is then associated to a single ns3::Ipv4 object through its ns3::Ipv4::SetRoutingProtocol.

Definition at line 185 of file internet-stack-helper.cc.

References ns3::Ipv4RoutingHelper::Copy(), and m_routing.

Referenced by ChainRegressionTest::CreateDevices(), Bug772ChainTest::CreateDevices(), ns3::aodv::LoopbackTestCase::DoRun(), Ipv4RipTest::DoRun(), Ipv4RipCountToInfinityTest::DoRun(), Ipv4RipSplitHorizonStrategyTest::DoRun(), Ipv6RipngTest::DoRun(), Ipv6RipngCountToInfinityTest::DoRun(), Ipv6RipngSplitHorizonStrategyTest::DoRun(), and Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetRoutingHelper() [2/2]

void ns3::InternetStackHelper::SetRoutingHelper ( const Ipv6RoutingHelper & routing )

Set IPv6 routing helper.

Parameters

routing IPv6 routing helper

Definition at line 192 of file internet-stack-helper.cc.

References ns3::Ipv6RoutingHelper::Copy(), and m_routingv6.

Here is the call graph for this function:

Member Data Documentation

◆ m_ipv4ArpJitterEnabled

bool ns3::InternetStackHelper::m_ipv4ArpJitterEnabled

private

IPv4 ARP Jitter state (enabled/disabled) ?

Definition at line 338 of file internet-stack-helper.h.

Referenced by InternetStackHelper(), Install(), Reset(), and SetIpv4ArpJitter().

◆ m_ipv4Enabled

bool ns3::InternetStackHelper::m_ipv4Enabled

private

IPv4 install state (enabled/disabled) ?

Definition at line 328 of file internet-stack-helper.h.

Referenced by InternetStackHelper(), EnableAsciiIpv4Internal(), EnablePcapIpv4Internal(), Install(), Reset(), and SetIpv4StackInstall().

◆ m_ipv6Enabled

bool ns3::InternetStackHelper::m_ipv6Enabled

private

IPv6 install state (enabled/disabled) ?

Definition at line 333 of file internet-stack-helper.h.

Referenced by InternetStackHelper(), EnableAsciiIpv6Internal(), EnablePcapIpv6Internal(), Install(), Reset(), and SetIpv6StackInstall().

◆ m_ipv6NsRsJitterEnabled

bool ns3::InternetStackHelper::m_ipv6NsRsJitterEnabled

private

IPv6 IPv6 NS and RS Jitter state (enabled/disabled) ?

Definition at line 343 of file internet-stack-helper.h.

Referenced by InternetStackHelper(), Install(), Reset(), and SetIpv6NsRsJitter().

◆ m_routing

const Ipv4RoutingHelper* ns3::InternetStackHelper::m_routing

private

IPv4 routing helper.

Definition at line 282 of file internet-stack-helper.h.

Referenced by InternetStackHelper(), ~InternetStackHelper(), Install(), operator=(), Reset(), and SetRoutingHelper().

◆ m_routingv6

const Ipv6RoutingHelper* ns3::InternetStackHelper::m_routingv6

private

IPv6 routing helper.

Definition at line 287 of file internet-stack-helper.h.

Referenced by InternetStackHelper(), ~InternetStackHelper(), Install(), operator=(), Reset(), and SetRoutingHelper().

The documentation for this class was generated from the following files:

src/internet/helper/internet-stack-helper.h
src/internet/helper/internet-stack-helper.cc

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InternetStackHelper() [1/2]

◆ ~InternetStackHelper()

◆ InternetStackHelper() [2/2]

Member Function Documentation

◆ AsciiHooked() [1/2]

◆ AsciiHooked() [2/2]

◆ AssignStreams()

◆ CreateAndAggregateObjectFromTypeId()

◆ EnableAsciiIpv4Internal()

◆ EnableAsciiIpv6Internal()

◆ EnablePcapIpv4Internal()

◆ EnablePcapIpv6Internal()

◆ Initialize()

◆ Install() [1/3]

◆ Install() [2/3]

◆ Install() [3/3]

◆ InstallAll()

◆ operator=()

◆ PcapHooked() [1/2]

◆ PcapHooked() [2/2]

◆ Reset()

◆ SetIpv4ArpJitter()

◆ SetIpv4StackInstall()

◆ SetIpv6NsRsJitter()

◆ SetIpv6StackInstall()

◆ SetRoutingHelper() [1/2]

◆ SetRoutingHelper() [2/2]

Member Data Documentation

◆ m_ipv4ArpJitterEnabled

◆ m_ipv4Enabled

◆ m_ipv6Enabled

◆ m_ipv6NsRsJitterEnabled

◆ m_routing

◆ m_routingv6