module.moduleBase.ModuleBase Class Reference

Main module class. More...

Public Member Functions
	__init__ (self, moduleName, config)
	init preload some needed locals and then call onLoad() directly
	onLoad (self)
	Called by import of the module can be inherited.
	doWork (self, bwPacket)
	Called module run can be inherited.
	onUnload (self)
	Called on shutdown of boswatch can be inherited.

Static Public Member Functions
	registerWildcard (newWildcard, bwPacketField)
	Register a new wildcard.

Data Fields
	config

Protected Member Functions
	_cleanup (self)
	Cleanup routine calls onUnload() directly.
	_run (self, bwPacket)
	start an run of the module.
	_getStatistics (self)
	Returns statistical information's from last module run.

Protected Attributes
	_moduleName
	_cumTime
	_moduleTime
	_runCount
	_moduleErrorCount

Static Protected Attributes
list	_modulesActive = []

Detailed Description

Main module class.

Constructor & Destructor Documentation

__init__()

module.moduleBase.ModuleBase.__init__	(		self,
			moduleName,
			config
	)

init preload some needed locals and then call onLoad() directly

Reimplemented in module.descriptor.BoswatchModule, module.filter.doubleFilter.BoswatchModule, module.filter.modeFilter.BoswatchModule, module.filter.regexFilter.BoswatchModule, module.geocoding.BoswatchModule, module.multicast.BoswatchModule, and module.template_module.BoswatchModule.

    def __init__(self, moduleName, config):
        r"""!init preload some needed locals and then call onLoad() directly"""
        self._moduleName = moduleName
        self.config = config
        self._modulesActive.append(self)
 
        # for time counting
        self._cumTime = 0
        self._moduleTime = 0
 
        # for statistics
        self._runCount = 0
        self._moduleErrorCount = 0
 
        logging.debug("[%s] onLoad()", moduleName)
        self.onLoad()
 

Member Function Documentation

_cleanup()

module.moduleBase.ModuleBase._cleanup (   self )

protected

Cleanup routine calls onUnload() directly.

    def _cleanup(self):
        r"""!Cleanup routine calls onUnload() directly"""
        logging.debug("[%s] onUnload()", self._moduleName)
        self._modulesActive.remove(self)
        self.onUnload()
 

_run()

module.moduleBase.ModuleBase._run (   self,   bwPacket  )

protected

start an run of the module.

Parameters

bwPacket

A BOSWatch packet instance

Returns

bwPacket or False

    def _run(self, bwPacket):
        r"""!start an run of the module.
 
        @param bwPacket: A BOSWatch packet instance
        @return bwPacket or False"""
 
        # --- FIX: Multicast list support for Module ---
        if isinstance(bwPacket, list):
            result_packets = []
            for single_packet in bwPacket:
                # Recursive call for single packet
                processed = self._run(single_packet)
 
                # new logic:
                if processed is False:
                    # filter called 'False' -> packet discarded
                    continue
                elif processed is None:
                    # module returned None -> keep packet unchanged
                    result_packets.append(single_packet)
                elif isinstance(processed, list):
                    # module returned new list -> extend
                    result_packets.extend(processed)
                else:
                    # module returned modified packet -> add
                    result_packets.append(processed)
 
            # if list is not empty, return it. else False (filter all).
            return result_packets if result_packets else False
        # -----------------------------------------------
 
        self._runCount += 1
        logging.debug("[%s] run #%d", self._moduleName, self._runCount)
 
        tmpTime = time.time()
        try:
            logging.debug("[%s] doWork()", self._moduleName)
            bwPacket = self.doWork(bwPacket)
        except:
            self._moduleErrorCount += 1
            logging.exception("[%s] alarm error", self._moduleName)
        self._moduleTime = time.time() - tmpTime
 
        self._cumTime += self._moduleTime
 
        logging.debug("[%s] took %0.3f seconds", self._moduleName, self._moduleTime)
 
        return bwPacket
 

_getStatistics()

module.moduleBase.ModuleBase._getStatistics (   self )

protected

Returns statistical information's from last module run.

Returns

Statistics as pyton dict

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

onLoad()

module.moduleBase.ModuleBase.onLoad

(

self

)

Called by import of the module can be inherited.

Reimplemented in module.descriptor.BoswatchModule, module.filter.doubleFilter.BoswatchModule, module.filter.modeFilter.BoswatchModule, module.filter.regexFilter.BoswatchModule, module.multicast.BoswatchModule, and module.template_module.BoswatchModule.

    def onLoad(self):
        r"""!Called by import of the module
        can be inherited"""
        pass
 

doWork()

module.moduleBase.ModuleBase.doWork	(		self,
			bwPacket
	)

Called module run can be inherited.

Parameters

bwPacket

bwPacket instance

Reimplemented in module.descriptor.BoswatchModule, module.filter.doubleFilter.BoswatchModule, module.filter.modeFilter.BoswatchModule, module.filter.regexFilter.BoswatchModule, module.geocoding.BoswatchModule, module.multicast.BoswatchModule, and module.template_module.BoswatchModule.

    def doWork(self, bwPacket):
        r"""!Called module run
        can be inherited
 
        @param bwPacket: bwPacket instance"""
        logging.warning("no functionality in module %s", self._moduleName)
 

onUnload()

module.moduleBase.ModuleBase.onUnload

(

self

)

Called on shutdown of boswatch can be inherited.

Reimplemented in module.descriptor.BoswatchModule, module.filter.doubleFilter.BoswatchModule, module.filter.modeFilter.BoswatchModule, module.filter.regexFilter.BoswatchModule, module.multicast.BoswatchModule, and module.template_module.BoswatchModule.

    def onUnload(self):
        r"""!Called on shutdown of boswatch
        can be inherited"""
        pass
 

registerWildcard()

module.moduleBase.ModuleBase.registerWildcard (   newWildcard,   bwPacketField  )

static

Register a new wildcard.

Parameters

newWildcard	wildcard where parser searching for
bwPacketField	field from bwPacket where holds replacement data

    def registerWildcard(newWildcard, bwPacketField):
        r"""!Register a new wildcard
 
        @param newWildcard: wildcard where parser searching for
        @param bwPacketField: field from bwPacket where holds replacement data"""
        if not newWildcard.startswith("{") or not newWildcard.endswith("}"):
            logging.error("wildcard not registered - false format: %s", newWildcard)
            return
        if bwPacketField == "":
            logging.error("wildcard not registered - bwPacket field is empty")
            return
        wildcard.registerWildcard(newWildcard, bwPacketField)

Field Documentation

_modulesActive

list module.moduleBase.ModuleBase._modulesActive = []

staticprotected

_moduleName

module.moduleBase.ModuleBase._moduleName

protected

config

module.moduleBase.ModuleBase.config

_cumTime

module.moduleBase.ModuleBase._cumTime

protected

_moduleTime

module.moduleBase.ModuleBase._moduleTime

protected

_runCount

module.moduleBase.ModuleBase._runCount

protected

_moduleErrorCount

module.moduleBase.ModuleBase._moduleErrorCount

protected