edb4222cc8c89eb612443e1750cebc3e5069d4d4
[nepi.git] / src / nepi / resources / linux / ns3 / ccn / ns3fibentrydceapplication.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 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
18
19 from nepi.execution.attribute import Attribute, Flags, Types
20 from nepi.execution.resource import clsinit_copy, ResourceState
21 from nepi.resources.linux.ns3.ccn.ns3ccndceapplication import LinuxNS3CCNDceApplication
22
23 @clsinit_copy
24 class LinuxNS3DceFIBEntry(LinuxNS3CCNDceApplication):
25     _rtype = "linux::ns3::dce::FIBEntry"
26
27     @classmethod
28     def _register_attributes(cls):
29         uri = Attribute("uri",
30                 "URI prefix to match and route for this FIB entry",
31                 default = "ccnx:/",
32                 flags = Flags.Design)
33
34         protocol = Attribute("protocol",
35                 "Transport protocol used in network connection to peer "
36                 "for this FIB entry. One of 'udp' or 'tcp'.",
37                 type = Types.Enumerate, 
38                 default = "udp",
39                 allowed = ["udp", "tcp"],
40                 flags = Flags.Design)
41
42         host = Attribute("host",
43                 "Peer hostname used in network connection for this FIB entry. ",
44                 flags = Flags.Design)
45
46         port = Attribute("port",
47                 "Peer port address used in network connection to peer "
48                 "for this FIB entry.",
49                 flags = Flags.Design)
50
51         ip = Attribute("ip",
52                 "Peer host public IP used in network connection for this FIB entry. ",
53                 flags = Flags.Design)
54
55         home = Attribute("home", "Sets HOME environmental variable. ",
56                 default = "/root",
57             flags = Flags.Design)
58  
59         cls._register_attribute(uri)
60         cls._register_attribute(protocol)
61         cls._register_attribute(host)
62         cls._register_attribute(port)
63         cls._register_attribute(ip)
64         cls._register_attribute(home)
65
66     def _instantiate_object(self):
67         if not self.get("binary"):
68             self.set("binary", "ccndc")
69             
70         if not self.get("arguments"):
71             self.set("arguments", self._arguments)
72
73         if not self.get("environment"):
74             self.set("environment", self._environment)
75         
76         super(LinuxNS3DceFIBEntry, self)._instantiate_object()
77
78     @property
79     def _environment(self):
80         envs = dict({
81             "home": "HOME",
82             })
83
84         env = ";".join(["%s=%s" % (envs.get(k), str(self.get(k))) for k in [k for k in list(envs.keys()) if self.get(k)]])
85
86         return env
87
88     @property
89     def _arguments(self):
90         args = ["-v", "add"]
91
92         if self.get("uri"):
93             args.append(self.get("uri"))
94         if self.get("protocol"):
95             args.append(self.get("protocol"))
96         if self.get("host"):
97             args.append(self.get("host"))
98         if self.get("port"):
99             args.append(self.get("port"))
100         if self.get("ip"):
101             args.append(self.get("ip"))
102
103         return ";".join(args) 
104
105