nepi/resources/ns3/classes/packet_sink.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 NS3PacketSink(NS3BaseApplication):
  26     _rtype = "ns3::PacketSink"
  27
  28     @classmethod
  29     def _register_attributes(cls):
  30
  31         attr_local = Attribute("Local",
  32             "The Address on which to Bind the rx socket.",
  33             type = Types.String,
  34             default = "00-00-00",
  35             allowed = None,
  36             range = None,
  37             flags = Flags.Reserved | Flags.Construct)
  38
  39         cls._register_attribute(attr_local)
  40
  41         attr_protocol = Attribute("Protocol",
  42             "The type id of the protocol to use for the rx socket.",
  43             type = Types.String,
  44             default = "ns3::UdpSocketFactory",
  45             allowed = None,
  46             range = None,
  47             flags = Flags.Reserved | Flags.Construct)
  48
  49         cls._register_attribute(attr_protocol)
  50
  51         attr_starttime = Attribute("StartTime",
  52             "Time at which the application will start",
  53             type = Types.String,
  54             default = "+0.0ns",
  55             allowed = None,
  56             range = None,
  57             flags = Flags.Reserved | Flags.Construct)
  58
  59         cls._register_attribute(attr_starttime)
  60
  61         attr_stoptime = Attribute("StopTime",
  62             "Time at which the application will stop",
  63             type = Types.String,
  64             default = "+0.0ns",
  65             allowed = None,
  66             range = None,
  67             flags = Flags.Reserved | Flags.Construct)
  68
  69         cls._register_attribute(attr_stoptime)
  70
  71
  72
  73     @classmethod
  74     def _register_traces(cls):
  75
  76         rx = Trace("Rx", "A packet has been received")
  77
  78         cls._register_trace(rx)
  79
  80
  81
  82     def __init__(self, ec, guid):
  83         super(NS3PacketSink, self).__init__(ec, guid)
  84         self._home = "ns3-packet-sink-%s" % self.guid