ns3::PacketSinkHelper Class Reference

A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes. More...

#include <packet-sink-helper.h>

Collaboration diagram for ns3::PacketSinkHelper:

Public Member Functions
	PacketSinkHelper (std::string protocol, Address address)
ApplicationContainer	Install (NodeContainer c) const
ApplicationContainer	Install (Ptr< Node > node) const
ApplicationContainer	Install (std::string nodeName) const
void	SetAttribute (std::string name, const AttributeValue &value)

Private Member Functions
Ptr< Application >	InstallPriv (Ptr< Node > node) const

Private Attributes
ObjectFactory	m_factory

Detailed Description

A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.

Definition at line 34 of file packet-sink-helper.h.

Constructor & Destructor Documentation

ns3::PacketSinkHelper::PacketSinkHelper	(	std::string	protocol,
		Address	address
	)

Create a PacketSinkHelper to make it easier to work with PacketSinkApplications

Parameters

protocol	the name of the protocol to use to receive traffic This string identifies the socket factory type used to create sockets for the applications. A typical value would be ns3::TcpSocketFactory.
address	the address of the sink,

Definition at line 28 of file packet-sink-helper.cc.

References m_factory, ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().

Here is the call graph for this function:

Member Function Documentation

ApplicationContainer ns3::PacketSinkHelper::Install

(

NodeContainer

c

)

const

Install an ns3::PacketSinkApplication on each node of the input container configured with all the attributes set with SetAttribute.

Parameters

c	NodeContainer of the set of nodes on which a PacketSinkApplication will be installed.

Definition at line 55 of file packet-sink-helper.cc.

References ns3::ApplicationContainer::Add(), ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), and InstallPriv().

Referenced by BuildAppsTest(), ns3::aodv::Bug772ChainTest::CreateDevices(), WifiMsduAggregatorThroughputTest::DoRun(), StaticRoutingSlash32TestCase::DoRun(), Ns3TcpNoDelayTestCase::DoRun(), Ns3TcpSocketTestCase1::DoRun(), NscTcpLossTestCase1::DoRun(), CsmaBridgeTestCase::DoRun(), Ns3TcpLossTestCase::DoRun(), Ns3TcpStateTestCase::DoRun(), ns3::EpcS1uDlTestCase::DoRun(), Ns3TcpInteroperabilityTestCase::DoRun(), ns3::LteEpcE2eDataTestCase::DoRun(), Ns3TcpSocketTestCase2::DoRun(), CsmaBroadcastTestCase::DoRun(), NscTcpLossTestCase2::DoRun(), Ns3TcpCwndTestCase1::DoRun(), ns3::EpcS1uUlTestCase::DoRun(), CsmaMulticastTestCase::DoRun(), GlobalRoutingSlash32TestCase::DoRun(), Ns3TcpCwndTestCase2::DoRun(), CsmaOneSubnetTestCase::DoRun(), CsmaPacketSocketTestCase::DoRun(), CsmaPingTestCase::DoRun(), CsmaRawIpSocketTestCase::DoRun(), CsmaStarTestCase::DoRun(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

ApplicationContainer ns3::PacketSinkHelper::Install

(

Ptr< Node >

node

)

const

Install an ns3::PacketSinkApplication on each node of the input container configured with all the attributes set with SetAttribute.

Parameters

node	The node on which a PacketSinkApplication will be installed.

Definition at line 42 of file packet-sink-helper.cc.

References InstallPriv().

Here is the call graph for this function:

ApplicationContainer ns3::PacketSinkHelper::Install

(

std::string

nodeName

)

const

Install an ns3::PacketSinkApplication on each node of the input container configured with all the attributes set with SetAttribute.

Parameters

nodeName

The name of the node on which a PacketSinkApplication will be installed.

Definition at line 48 of file packet-sink-helper.cc.

References InstallPriv().

Here is the call graph for this function:

Ptr< Application > ns3::PacketSinkHelper::InstallPriv ( Ptr< Node >  node ) const

private

Definition at line 67 of file packet-sink-helper.cc.

References ns3::Node::AddApplication(), ns3::ObjectFactory::Create(), and m_factory.

Referenced by Install().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::PacketSinkHelper::SetAttribute	(	std::string	name,
		const AttributeValue &	value
	)

Helper function used to set the underlying application attributes.

Parameters

name	the name of the application attribute to set
value	the value of the application attribute to set

Definition at line 36 of file packet-sink-helper.cc.

References m_factory, and ns3::ObjectFactory::Set().

Here is the call graph for this function:

Member Data Documentation

ObjectFactory ns3::PacketSinkHelper::m_factory

private

Definition at line 87 of file packet-sink-helper.h.

Referenced by InstallPriv(), PacketSinkHelper(), and SetAttribute().

---

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

• src/applications/helper/packet-sink-helper.h
• src/applications/helper/packet-sink-helper.cc