A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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"

+ Inheritance diagram for ns3::PacketSinkHelper:
+ Collaboration diagram for ns3::PacketSinkHelper:

Public Member Functions

 PacketSinkHelper (const std::string &protocol, const Address &address)
 Create a PacketSinkHelper to make it easier to work with PacketSinkApplications.
 
- Public Member Functions inherited from ns3::ApplicationHelper
 ApplicationHelper (const std::string &typeId)
 Create an application of a given type ID.
 
 ApplicationHelper (TypeId typeId)
 Create an application of a given type ID.
 
int64_t AssignStreams (NodeContainer c, int64_t stream)
 Assigns a unique (monotonically increasing) stream number to all applications that match the configured type of this application helper instance.
 
ApplicationContainer Install (const std::string &nodeName)
 Install an application on the node configured with all the attributes set with SetAttribute.
 
ApplicationContainer Install (NodeContainer c)
 Install an application on each node of the input container configured with all the attributes set with SetAttribute.
 
ApplicationContainer Install (Ptr< Node > node)
 Install an application on the node configured with all the attributes set with SetAttribute.
 
void SetAttribute (const std::string &name, const AttributeValue &value)
 Helper function used to set the underlying application attributes.
 
void SetTypeId (const std::string &typeId)
 Allow the helper to be repurposed for another application type.
 
void SetTypeId (TypeId typeId)
 Allow the helper to be repurposed for another application type.
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::ApplicationHelper
static int64_t AssignStreamsToAllApps (NodeContainer c, int64_t stream)
 Assign a fixed random variable stream number to the random variables used by all the applications.
 
- Protected Member Functions inherited from ns3::ApplicationHelper
virtual Ptr< ApplicationDoInstall (Ptr< Node > node)
 Install an application on the node configured with all the attributes set with SetAttribute.
 
- Protected Attributes inherited from ns3::ApplicationHelper
ObjectFactory m_factory
 Object factory.
 

Detailed Description

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

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

Constructor & Destructor Documentation

◆ PacketSinkHelper()

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

Create a PacketSinkHelper to make it easier to work with PacketSinkApplications.

Parameters
protocolthe 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.
addressthe address of the sink,

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

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

+ Here is the call graph for this function:

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