/usr/include/ns3.17/ns3/udp-echo-helper.h is in libns3-dev 3.17+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2008 INRIA
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
*/
#ifndef UDP_ECHO_HELPER_H
#define UDP_ECHO_HELPER_H
#include <stdint.h>
#include "ns3/application-container.h"
#include "ns3/node-container.h"
#include "ns3/object-factory.h"
#include "ns3/ipv4-address.h"
#include "ns3/ipv6-address.h"
namespace ns3 {
/**
* \brief Create a server application which waits for input udp packets
* and sends them back to the original sender.
*/
class UdpEchoServerHelper
{
public:
/**
* Create UdpEchoServerHelper which will make life easier for people trying
* to set up simulations with echos.
*
* \param port The port the server will wait on for incoming packets
*/
UdpEchoServerHelper (uint16_t port);
/**
* Record an attribute to be set in each Application after it is is created.
*
* \param name the name of the attribute to set
* \param value the value of the attribute to set
*/
void SetAttribute (std::string name, const AttributeValue &value);
/**
* Create a UdpEchoServerApplication on the specified Node.
*
* \param node The node on which to create the Application. The node is
* specified by a Ptr<Node>.
*
* \returns An ApplicationContainer holding the Application created,
*/
ApplicationContainer Install (Ptr<Node> node) const;
/**
* Create a UdpEchoServerApplication on specified node
*
* \param nodeName The node on which to create the application. The node
* is specified by a node name previously registered with
* the Object Name Service.
*
* \returns An ApplicationContainer holding the Application created.
*/
ApplicationContainer Install (std::string nodeName) const;
/**
* \param c The nodes on which to create the Applications. The nodes
* are specified by a NodeContainer.
*
* Create one udp echo server application on each of the Nodes in the
* NodeContainer.
*
* \returns The applications created, one Application per Node in the
* NodeContainer.
*/
ApplicationContainer Install (NodeContainer c) const;
private:
/**
* \internal
*/
Ptr<Application> InstallPriv (Ptr<Node> node) const;
ObjectFactory m_factory;
};
/**
* \brief create an application which sends a udp packet and waits for an echo of this packet
*/
class UdpEchoClientHelper
{
public:
/**
* Create UdpEchoClientHelper which will make life easier for people trying
* to set up simulations with echos.
*
* \param ip The IP address of the remote udp echo server
* \param port The port number of the remote udp echo server
*/
UdpEchoClientHelper (Address ip, uint16_t port);
UdpEchoClientHelper (Ipv4Address ip, uint16_t port);
UdpEchoClientHelper (Ipv6Address ip, uint16_t port);
/**
* Record an attribute to be set in each Application after it is is created.
*
* \param name the name of the attribute to set
* \param value the value of the attribute to set
*/
void SetAttribute (std::string name, const AttributeValue &value);
/**
* Given a pointer to a UdpEchoClient application, set the data fill of the
* packet (what is sent as data to the server) to the contents of the fill
* string (including the trailing zero terminator).
*
* \warning The size of resulting echo packets will be automatically adjusted
* to reflect the size of the fill string -- this means that the PacketSize
* attribute may be changed as a result of this call.
*
* \param app Smart pointer to the application (real type must be UdpEchoClient).
* \param fill The string to use as the actual echo data bytes.
*/
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 to the server) to the contents of the fill
* byte.
*
* The fill byte will be used to initialize the contents of the data packet.
*
* \warning The size of resulting echo packets will be automatically adjusted
* to reflect the dataLength parameter -- this means that the PacketSize
* attribute may be changed as a result of this call.
*
* \param app Smart pointer to the application (real type must be UdpEchoClient).
* \param fill The byte to be repeated in constructing the packet data..
* \param dataLength The desired length of the resulting echo packet data.
*/
void SetFill (Ptr<Application> app, uint8_t fill, uint32_t dataLength);
/**
* Given a pointer to a UdpEchoClient application, set the data fill of the
* packet (what is sent as data to the server) to the contents of the fill
* buffer, repeated as many times as is required.
*
* Initializing the fill to the contents of a single buffer is accomplished
* by providing a complete buffer with fillLength set to your desired
* dataLength
*
* \warning The size of resulting echo packets will be automatically adjusted
* to reflect the dataLength parameter -- this means that the PacketSize
* attribute of the Application may be changed as a result of this call.
*
* \param app Smart pointer to the application (real type must be UdpEchoClient).
* \param fill The fill pattern to use when constructing packets.
* \param fillLength The number of bytes in the provided fill pattern.
* \param dataLength The desired length of the final echo data.
*/
void SetFill (Ptr<Application> app, uint8_t *fill, uint32_t fillLength, uint32_t dataLength);
/**
* Create a udp echo client application on the specified node. The Node
* is provided as a Ptr<Node>.
*
* \param node The Ptr<Node> on which to create the UdpEchoClientApplication.
*
* \returns An ApplicationContainer that holds a Ptr<Application> to the
* application created
*/
ApplicationContainer Install (Ptr<Node> node) const;
/**
* Create a udp echo client application on the specified node. The Node
* is provided as a string name of a Node that has been previously
* associated using the Object Name Service.
*
* \param nodeName The name of the node on which to create the UdpEchoClientApplication
*
* \returns An ApplicationContainer that holds a Ptr<Application> to the
* application created
*/
ApplicationContainer Install (std::string nodeName) const;
/**
* \param c the nodes
*
* Create one udp echo client application on each of the input nodes
*
* \returns the applications created, one application per input node.
*/
ApplicationContainer Install (NodeContainer c) const;
private:
Ptr<Application> InstallPriv (Ptr<Node> node) const;
ObjectFactory m_factory;
};
} // namespace ns3
#endif /* UDP_ECHO_HELPER_H */
|