A Discrete-Event Network Simulator
API
packet-sink-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef PACKET_SINK_HELPER_H
21 #define PACKET_SINK_HELPER_H
22 
23 #include "ns3/object-factory.h"
24 #include "ns3/ipv4-address.h"
25 #include "ns3/node-container.h"
26 #include "ns3/application-container.h"
27 
28 namespace ns3 {
29 
35 class PacketSinkHelper
36 {
37 public:
48  PacketSinkHelper (std::string protocol, Address address);
49 
56  void SetAttribute (std::string name, const AttributeValue &value);
57 
66  ApplicationContainer Install (NodeContainer c) const;
67 
75  ApplicationContainer Install (Ptr<Node> node) const;
76 
84  ApplicationContainer Install (std::string nodeName) const;
85 
86 private:
94  Ptr<Application> InstallPriv (Ptr<Node> node) const;
95  ObjectFactory m_factory;
96 };
97 
98 } // namespace ns3
99 
100 #endif /* PACKET_SINK_HELPER_H */
ns3::Address
a polymophic address class
Definition: address.h:91
ns3::ApplicationContainer
holds a vector of ns3::Application pointers.
Definition: application-container.h:43
ns3::AttributeValue
Hold a value for an Attribute.
Definition: attribute.h:69
ns3::NodeContainer
keep track of a set of node pointers.
Definition: node-container.h:39
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition: object-factory.h:48
ns3::PacketSinkHelper
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.
Definition: packet-sink-helper.h:36
ns3::PacketSinkHelper::SetAttribute
void SetAttribute(std::string name, const AttributeValue &value)
Helper function used to set the underlying application attributes.
Definition: packet-sink-helper.cc:36
ns3::PacketSinkHelper::Install
ApplicationContainer Install(NodeContainer c) const
Install an ns3::PacketSinkApplication on each node of the input container configured with all the att...
Definition: packet-sink-helper.cc:55
ns3::PacketSinkHelper::m_factory
ObjectFactory m_factory
Object factory.
Definition: packet-sink-helper.h:95
ns3::PacketSinkHelper::PacketSinkHelper
PacketSinkHelper(std::string protocol, Address address)
Create a PacketSinkHelper to make it easier to work with PacketSinkApplications.
Definition: packet-sink-helper.cc:28
ns3::PacketSinkHelper::InstallPriv
Ptr< Application > InstallPriv(Ptr< Node > node) const
Install an ns3::PacketSink on the node configured with all the attributes set with SetAttribute.
Definition: packet-sink-helper.cc:67
first.address
address
Definition: first.py:44
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.