A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::BulkSendHelper Class Reference

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

#include <bulk-send-helper.h>

Public Member Functions

 BulkSendHelper (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< ApplicationInstallPriv (Ptr< Node > node) const
 

Private Attributes

ObjectFactory m_factory
 
std::string m_protocol
 
Address m_remote
 

Detailed Description

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

Definition at line 41 of file bulk-send-helper.h.

Constructor & Destructor Documentation

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

Create an BulkSendHelper to make it easier to work with BulkSendApplications

Parameters
protocolthe name of the protocol to use to send traffic by the applications. This string identifies the socket factory type used to create sockets for the applications. A typical value would be ns3::UdpSocketFactory.
addressthe address of the remote node to send traffic to.

Definition at line 31 of file bulk-send-helper.cc.

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

Member Function Documentation

ApplicationContainer ns3::BulkSendHelper::Install ( NodeContainer  c) const

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

Parameters
cNodeContainer of the set of nodes on which an BulkSendApplication will be installed.
Returns
Container of Ptr to the applications installed.

Definition at line 58 of file bulk-send-helper.cc.

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

Referenced by ns3::LteX2HandoverTestCase::DoRun().

ApplicationContainer ns3::BulkSendHelper::Install ( Ptr< Node node) const

Install an ns3::BulkSendApplication on the node configured with all the attributes set with SetAttribute.

Parameters
nodeThe node on which an BulkSendApplication will be installed.
Returns
Container of Ptr to the applications installed.

Definition at line 45 of file bulk-send-helper.cc.

References InstallPriv().

ApplicationContainer ns3::BulkSendHelper::Install ( std::string  nodeName) const

Install an ns3::BulkSendApplication on the node configured with all the attributes set with SetAttribute.

Parameters
nodeNameThe node on which an BulkSendApplication will be installed.
Returns
Container of Ptr to the applications installed.

Definition at line 51 of file bulk-send-helper.cc.

References InstallPriv().

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

Install an ns3::BulkSendApplication on the node configured with all the attributes set with SetAttribute.

Parameters
nodeThe node on which an BulkSendApplication will be installed.
Returns
Ptr to the application installed.

Definition at line 70 of file bulk-send-helper.cc.

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

Referenced by Install().

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

Helper function used to set the underlying application attributes, not the socket attributes.

Parameters
namethe name of the application attribute to set
valuethe value of the application attribute to set

Definition at line 39 of file bulk-send-helper.cc.

References ns3::ObjectFactory::Set().

Referenced by ns3::LteX2HandoverTestCase::DoRun().


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