Source code for nepi.resources.linux.ns3.ccn.ns3fibentrydceapplication

#
#    NEPI, a framework to manage network experiments
#    Copyright (C) 2014 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, see <http://www.gnu.org/licenses/>.
#
# Author: Alina Quereilhac <alina.quereilhac@inria.fr>

from nepi.execution.attribute import Attribute, Flags, Types
from nepi.execution.resource import clsinit_copy, ResourceState
from nepi.resources.linux.ns3.ccn.ns3ccndceapplication import LinuxNS3CCNDceApplication

@clsinit_copy
class LinuxNS3DceFIBEntry(LinuxNS3CCNDceApplication):
    _rtype = "linux::ns3::dce::FIBEntry"

    @classmethod
    def _register_attributes(cls):
        uri = Attribute("uri",
                "URI prefix to match and route for this FIB entry",
                default = "ccnx:/",
                flags = Flags.Design)

        protocol = Attribute("protocol",
                "Transport protocol used in network connection to peer "
                "for this FIB entry. One of 'udp' or 'tcp'.",
                type = Types.Enumerate, 
                default = "udp",
                allowed = ["udp", "tcp"],
                flags = Flags.Design)

        host = Attribute("host",
                "Peer hostname used in network connection for this FIB entry. ",
                flags = Flags.Design)

        port = Attribute("port",
                "Peer port address used in network connection to peer "
                "for this FIB entry.",
                flags = Flags.Design)

        ip = Attribute("ip",
                "Peer host public IP used in network connection for this FIB entry. ",
                flags = Flags.Design)

        home = Attribute("home", "Sets HOME environmental variable. ",
                default = "/root",
            flags = Flags.Design)
 
        cls._register_attribute(uri)
        cls._register_attribute(protocol)
        cls._register_attribute(host)
        cls._register_attribute(port)
        cls._register_attribute(ip)
        cls._register_attribute(home)

    def _instantiate_object(self):
        if not self.get("binary"):
            self.set("binary", "ccndc")
            
        if not self.get("arguments"):
            self.set("arguments", self._arguments)

        if not self.get("environment"):
            self.set("environment", self._environment)
        
        super(LinuxNS3DceFIBEntry, self)._instantiate_object()

    @property
    def _environment(self):
        envs = dict({
            "home": "HOME",
            })

        env = ";".join(map(lambda k: "%s=%s" % (envs.get(k), str(self.get(k))), 
            [k for k in envs.keys() if self.get(k)]))

        return env

    @property
    def _arguments(self):
        args = ["-v", "add"]

        if self.get("uri"):
            args.append(self.get("uri"))
        if self.get("protocol"):
            args.append(self.get("protocol"))
        if self.get("host"):
            args.append(self.get("host"))
        if self.get("port"):
            args.append(self.get("port"))
        if self.get("ip"):
            args.append(self.get("ip"))

        return ";".join(args)