README moves to markdown
[nepi.git] / src / nepi / resources / ns3 / classes / virtual_net_device.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.ns3netdevice import NS3BaseNetDevice 
23
24 @clsinit_copy
25 class NS3VirtualNetDevice(NS3BaseNetDevice):
26     _rtype = "ns3::VirtualNetDevice"
27
28     @classmethod
29     def _register_attributes(cls):
30         
31         attr_mtu = Attribute("Mtu",
32             "The MAC-level Maximum Transmission Unit",
33             type = Types.Integer,
34             default = "1500",  
35             allowed = None,
36             range = None,    
37             flags = Flags.Reserved | Flags.Construct)
38
39         cls._register_attribute(attr_mtu)
40
41
42
43     @classmethod
44     def _register_traces(cls):
45         
46         mactx = Trace("MacTx", "Trace source indicating a packet has arrived for transmission by this device")
47
48         cls._register_trace(mactx)
49
50         macpromiscrx = Trace("MacPromiscRx", "A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack.  This is a promiscuous trace,")
51
52         cls._register_trace(macpromiscrx)
53
54         macrx = Trace("MacRx", "A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack.  This is a non-promiscuous trace,")
55
56         cls._register_trace(macrx)
57
58         sniffer = Trace("Sniffer", "Trace source simulating a non-promiscuous packet sniffer attached to the device")
59
60         cls._register_trace(sniffer)
61
62         promiscsniffer = Trace("PromiscSniffer", "Trace source simulating a promiscuous packet sniffer attached to the device")
63
64         cls._register_trace(promiscsniffer)
65
66
67
68     def __init__(self, ec, guid):
69         super(NS3VirtualNetDevice, self).__init__(ec, guid)
70         self._home = "ns3-virtual-net-device-%s" % self.guid