boswatch.router.router.Router Class Reference

Class for the Router. More...

Public Member Functions
def	__init__ (self, name)
	Create a new router.
def	addRoute (self, route)
	Adds a route point to the router.
def	runRouter (self, bwPacket)
	Run the router.

Data Fields
	name
	routeList

Protected Member Functions
def	_getStatistics (self)
	Returns statistical information's from last router run.

Protected Attributes
	_cumTime
	_routerTime
	_runCount

Detailed Description

Class for the Router.

Constructor & Destructor Documentation

__init__()

def boswatch.router.router.Router.__init__	(		self,
			name
	)

Create a new router.

    @param name: name of the router

    def __init__(self, name):
        r"""!Create a new router
 
        @param name: name of the router"""
        self.name = name
        self.routeList = []
 
        # for time counting
        self._cumTime = 0
        self._routerTime = 0
 
        # for statistics
        self._runCount = 0
 
        logging.debug("[%s] add new router", self.name)
 

Member Function Documentation

addRoute()

def boswatch.router.router.Router.addRoute	(		self,
			route
	)

Adds a route point to the router.

    @param route: instance of the Route class

    def addRoute(self, route):
        r"""!Adds a route point to the router
 
        @param route: instance of the Route class
        """
        logging.debug("[%s] add route: %s", self.name, route.name)
        self.routeList.append(route)
 

runRouter()

def boswatch.router.router.Router.runRouter	(		self,
			bwPacket
	)

Run the router.

    @param bwPacket: instance of Packet class
    @return a instance of Packet class

    def runRouter(self, bwPacket):
        r"""!Run the router
 
        @param bwPacket: instance of Packet class
        @return a instance of Packet class
        """
        self._runCount += 1
        tmpTime = time.time()
 
        logging.debug("[%s] started", self.name)
 
        for routeObject in self.routeList:
            logging.debug("[%s] -> run route: %s", self.name, routeObject.name)
            bwPacket_tmp = routeObject.callback(copy.deepcopy(bwPacket))  # copy bwPacket to prevent edit the original
 
            if bwPacket_tmp is None:  # returning None doesnt change the bwPacket
                continue
 
            if bwPacket_tmp is False:  # returning False stops the router immediately
                logging.debug("[%s] stopped", self.name)
                break
 
            bwPacket = bwPacket_tmp
            logging.debug("[%s] bwPacket returned", self.name)
        logging.debug("[%s] finished", self.name)
 
        self._routerTime = time.time() - tmpTime
        self._cumTime += self._routerTime
 
        return bwPacket
 

_getStatistics()

def boswatch.router.router.Router._getStatistics (   self )

protected

Returns statistical information's from last router run.

    @return Statistics as pyton dict

    def _getStatistics(self):
        r"""!Returns statistical information's from last router run
 
        @return Statistics as pyton dict"""
        stats = {"type": "router",
                 "runCount": self._runCount,
                 "cumTime": self._cumTime,
                 "moduleTime": self._routerTime}
        return stats

Field Documentation

name

boswatch.router.router.Router.name

routeList

boswatch.router.router.Router.routeList

_cumTime

boswatch.router.router.Router._cumTime

protected

_routerTime

boswatch.router.router.Router._routerTime

protected

_runCount

boswatch.router.router.Router._runCount

protected