src/nepi/resources/ns3/classes/udp_echo_client.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2014 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, see <http://www.gnu.org/licenses/>.
  16 #
  17
  18 from nepi.execution.attribute import Attribute, Flags, Types
  19 from nepi.execution.trace import Trace, TraceAttr
  20 from nepi.execution.resource import ResourceManager, clsinit_copy, \
  21         ResourceState
  22 from nepi.resources.ns3.ns3application import NS3BaseApplication
  23
  24 @clsinit_copy
  25 class NS3UdpEchoClient(NS3BaseApplication):
  26     _rtype = "ns3::UdpEchoClient"
  27
  28     @classmethod
  29     def _register_attributes(cls):
  30
  31         attr_maxpackets = Attribute("MaxPackets",
  32             "The maximum number of packets the application will send",
  33             type = Types.Integer,
  34             default = "100",
  35             allowed = None,
  36             range = None,
  37             flags = Flags.Reserved | Flags.Construct)
  38
  39         cls._register_attribute(attr_maxpackets)
  40
  41         attr_interval = Attribute("Interval",
  42             "The time to wait between packets",
  43             type = Types.String,
  44             default = "+1000000000.0ns",
  45             allowed = None,
  46             range = None,
  47             flags = Flags.Reserved | Flags.Construct)
  48
  49         cls._register_attribute(attr_interval)
  50
  51         attr_remoteaddress = Attribute("RemoteAddress",
  52             "The destination Address of the outbound packets",
  53             type = Types.String,
  54             default = "00-00-00",
  55             allowed = None,
  56             range = None,
  57             flags = Flags.Reserved | Flags.Construct)
  58
  59         cls._register_attribute(attr_remoteaddress)
  60
  61         attr_remoteport = Attribute("RemotePort",
  62             "The destination port of the outbound packets",
  63             type = Types.Integer,
  64             default = "0",
  65             allowed = None,
  66             range = None,
  67             flags = Flags.Reserved | Flags.Construct)
  68
  69         cls._register_attribute(attr_remoteport)
  70
  71         attr_packetsize = Attribute("PacketSize",
  72             "Size of echo data in outbound packets",
  73             type = Types.Integer,
  74             default = "100",
  75             allowed = None,
  76             range = None,
  77             flags = Flags.Reserved | Flags.Construct)
  78
  79         cls._register_attribute(attr_packetsize)
  80
  81         attr_starttime = Attribute("StartTime",
  82             "Time at which the application will start",
  83             type = Types.String,
  84             default = "+0.0ns",
  85             allowed = None,
  86             range = None,
  87             flags = Flags.Reserved | Flags.Construct)
  88
  89         cls._register_attribute(attr_starttime)
  90
  91         attr_stoptime = Attribute("StopTime",
  92             "Time at which the application will stop",
  93             type = Types.String,
  94             default = "+0.0ns",
  95             allowed = None,
  96             range = None,
  97             flags = Flags.Reserved | Flags.Construct)
  98
  99         cls._register_attribute(attr_stoptime)
 100
 101
 102
 103     @classmethod
 104     def _register_traces(cls):
 105
 106         tx = Trace("Tx", "A new packet is created and is sent")
 107
 108         cls._register_trace(tx)
 109
 110
 111
 112     def __init__(self, ec, guid):
 113         super(NS3UdpEchoClient, self).__init__(ec, guid)
 114         self._home = "ns3-udp-echo-client-%s" % self.guid