A Discrete-Event Network Simulator
API
udp-echo-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 UDP_ECHO_HELPER_H
21 #define UDP_ECHO_HELPER_H
22 
23 #include <stdint.h>
24 #include "ns3/application-container.h"
25 #include "ns3/node-container.h"
26 #include "ns3/object-factory.h"
27 #include "ns3/ipv4-address.h"
28 #include "ns3/ipv6-address.h"
29 
30 namespace ns3 {
31 
37 class UdpEchoServerHelper
38 {
39 public:
46  UdpEchoServerHelper (uint16_t port);
47 
54  void SetAttribute (std::string name, const AttributeValue &value);
55 
64  ApplicationContainer Install (Ptr<Node> node) const;
65 
75  ApplicationContainer Install (std::string nodeName) const;
76 
87  ApplicationContainer Install (NodeContainer c) const;
88 
89 private:
97  Ptr<Application> InstallPriv (Ptr<Node> node) const;
98 
99  ObjectFactory m_factory;
100 };
101 
106 class UdpEchoClientHelper
107 {
108 public:
117  UdpEchoClientHelper (Address ip, uint16_t port);
125  UdpEchoClientHelper (Address addr);
126 
133  void SetAttribute (std::string name, const AttributeValue &value);
134 
147  void SetFill (Ptr<Application> app, std::string fill);
148 
164  void SetFill (Ptr<Application> app, uint8_t fill, uint32_t dataLength);
165 
184  void SetFill (Ptr<Application> app, uint8_t *fill, uint32_t fillLength, uint32_t dataLength);
185 
195  ApplicationContainer Install (Ptr<Node> node) const;
196 
207  ApplicationContainer Install (std::string nodeName) const;
208 
216  ApplicationContainer Install (NodeContainer c) const;
217 
218 private:
226  Ptr<Application> InstallPriv (Ptr<Node> node) const;
227  ObjectFactory m_factory;
228 };
229 
230 } // namespace ns3
231 
232 #endif /* UDP_ECHO_HELPER_H */
ns3::UdpEchoServerHelper::UdpEchoServerHelper
UdpEchoServerHelper(uint16_t port)
Create UdpEchoServerHelper which will make life easier for people trying to set up simulations with e...
Definition: udp-echo-helper.cc:28
ns3::UdpEchoClientHelper::UdpEchoClientHelper
UdpEchoClientHelper(Address ip, uint16_t port)
Create UdpEchoClientHelper which will make life easier for people trying to set up simulations with e...
Definition: udp-echo-helper.cc:76
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::UdpEchoServerHelper::Install
ApplicationContainer Install(Ptr< Node > node) const
Create a UdpEchoServerApplication on the specified Node.
Definition: udp-echo-helper.cc:43
ns3::UdpEchoClientHelper
Create an application which sends a UDP packet and waits for an echo of this packet.
Definition: udp-echo-helper.h:107
ns3::AttributeValue
Hold a value for an Attribute.
Definition: attribute.h:69
ns3::UdpEchoClientHelper::m_factory
ObjectFactory m_factory
Object factory.
Definition: udp-echo-helper.h:227
ns3::UdpEchoServerHelper::InstallPriv
Ptr< Application > InstallPriv(Ptr< Node > node) const
Install an ns3::UdpEchoServer on the node configured with all the attributes set with SetAttribute.
Definition: udp-echo-helper.cc:68
ns3::Ptr< Node >
ns3::Address
a polymophic address class
Definition: address.h:91
ns3::UdpEchoClientHelper::Install
ApplicationContainer Install(Ptr< Node > node) const
Create a udp echo client application on the specified node.
Definition: udp-echo-helper.cc:116
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition: object-factory.h:48
ns3::UdpEchoServerHelper::SetAttribute
void SetAttribute(std::string name, const AttributeValue &value)
Record an attribute to be set in each Application after it is is created.
Definition: udp-echo-helper.cc:35
ns3::UdpEchoServerHelper::m_factory
ObjectFactory m_factory
Object factory.
Definition: udp-echo-helper.h:99
ns3::ApplicationContainer
holds a vector of ns3::Application pointers.
Definition: application-container.h:43
ns3::NodeContainer
keep track of a set of node pointers.
Definition: node-container.h:39
ns3::UdpEchoClientHelper::InstallPriv
Ptr< Application > InstallPriv(Ptr< Node > node) const
Install an ns3::UdpEchoClient on the node configured with all the attributes set with SetAttribute.
Definition: udp-echo-helper.cc:141
ns3::UdpEchoClientHelper::SetAttribute
void SetAttribute(std::string name, const AttributeValue &value)
Record an attribute to be set in each Application after it is is created.
Definition: udp-echo-helper.cc:90
ns3::UdpEchoClientHelper::SetFill
void SetFill(Ptr< Application > app, std::string fill)
Given a pointer to a UdpEchoClient application, set the data fill of the packet (what is sent as data...
Definition: udp-echo-helper.cc:98
ns3::UdpEchoServerHelper
Create a server application which waits for input UDP packets and sends them back to the original sen...
Definition: udp-echo-helper.h:38
port
uint16_t port
Definition: dsdv-manet.cc:45