boswatch.router.route.Route Class Reference

Class for single routing points. More...

Public Member Functions
	__init__ (self, name, callback, statsCallback=None, cleanupCallback=None, isRouter=False)
	Create a instance of an route point.

Data Fields
	name
	callback
	statistics
	cleanup
	isRouter

Detailed Description

Class for single routing points.

Constructor & Destructor Documentation

__init__()

boswatch.router.route.Route.__init__	(		self,
			name,
			callback,
			statsCallback = None,
			cleanupCallback = None,
			isRouter = False
	)

Create a instance of an route point.

Parameters

name	name of the route point
callback	instance of the callback function
statsCallback	instance of the callback to get statistics (None)
cleanupCallback	instance of the callback to run a cleanup method (None)
isRouter	True if this route point jumps into another router (type: router). Used by Router._process_route_recursive() to distinguish a sub-router that filtered internally (continue with the parent's next route point) from a module/plugin that explicitly stops the whole route (stop immediately). (False)

    def __init__(self, name, callback, statsCallback=None, cleanupCallback=None, isRouter=False):
        r"""!Create a instance of an route point
 
        @param name: name of the route point
        @param callback: instance of the callback function
        @param statsCallback: instance of the callback to get statistics (None)
        @param cleanupCallback: instance of the callback to run a cleanup method (None)
        @param isRouter: True if this route point jumps into another router (type: router).
                         Used by Router._process_route_recursive() to distinguish a
                         sub-router that filtered internally (continue with the parent's
                         next route point) from a module/plugin that explicitly stops
                         the whole route (stop immediately). (False)
        """
        self.name = name
        self.callback = callback
        self.statistics = statsCallback
        self.cleanup = cleanupCallback
        self.isRouter = isRouter

Field Documentation

name

boswatch.router.route.Route.name

callback

boswatch.router.route.Route.callback

statistics

boswatch.router.route.Route.statistics

cleanup

boswatch.router.route.Route.cleanup

isRouter

boswatch.router.route.Route.isRouter