module.packetDump.BoswatchModule Class Reference

Ein Diagnose-Modul, das den kompletten Inhalt des bwPacket-Objekts im Log ausgibt. More...

Public Member Functions
	__init__ (self, config)
	Do not change anything here!
	onLoad (self)
	Called by import of the plugin.
	doWork (self, bwPacket)
	start an run of the module.
	onUnload (self)
	Called by destruction of the plugin Remove if not implemented.

Data Fields
	title
Data Fields inherited from module.moduleBase.ModuleBase
	config

Additional Inherited Members
Static Public Member Functions inherited from module.moduleBase.ModuleBase
	registerWildcard (newWildcard, bwPacketField)
	Register a new wildcard.
Protected Member Functions inherited from module.moduleBase.ModuleBase
	_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 inherited from module.moduleBase.ModuleBase
	_moduleName
	_cumTime
	_moduleTime
	_runCount
	_moduleErrorCount
Static Protected Attributes inherited from module.moduleBase.ModuleBase
list	_modulesActive = []

Detailed Description

Ein Diagnose-Modul, das den kompletten Inhalt des bwPacket-Objekts im Log ausgibt.

Constructor & Destructor Documentation

__init__()

module.packetDump.BoswatchModule.__init__	(		self,
			config
	)

Do not change anything here!

Reimplemented from module.moduleBase.ModuleBase.

    def __init__(self, config):
        r"""!Do not change anything here!"""
        super().__init__(__name__, config)  # you can access the config class on 'self.config'
 

Member Function Documentation

onLoad()

module.packetDump.BoswatchModule.onLoad

(

self

)

Called by import of the plugin.

Reimplemented from module.moduleBase.ModuleBase.

    def onLoad(self):
        r"""!Called by import of the plugin"""
        self.title = self.config.get("title", default="Packet Dump")
 

doWork()

module.packetDump.BoswatchModule.doWork	(		self,
			bwPacket
	)

start an run of the module.

Parameters

bwPacket

A BOSWatch packet instance Gibt das Paket unverändert weiter, loggt aber den aktuellen Zustand.

Reimplemented from module.moduleBase.ModuleBase.

    def doWork(self, bwPacket):
        r"""!start an run of the module.
 
        @param bwPacket: A BOSWatch packet instance
        Gibt das Paket unverändert weiter, loggt aber den aktuellen Zustand.
        """
        logging.debug("======= [DEBUG DUMP: %s] =======", self.title)
 
        try:
            # vars(bwPacket) extrahiert alle Attribute und internen Dicts des Objekts, damit wir auch die dynamisch hinzugefügten Multicast-Felder sehen.
            packet_details = vars(bwPacket)
            logging.debug("\n" + pprint.pformat(packet_details))
        except Exception as e:
            # Failsafe, falls vars() bei sehr speziellen Objekten fehlschlägt
            logging.warning(f"Konnte Paket-Details nicht vollständig auslesen: {e}")
            logging.debug("\n" + pprint.pformat(bwPacket))
 
        logging.debug("==========================================")
 
        return bwPacket
 

onUnload()

module.packetDump.BoswatchModule.onUnload

(

self

)

Called by destruction of the plugin Remove if not implemented.

Reimplemented from module.moduleBase.ModuleBase.

    def onUnload(self):
        r"""!Called by destruction of the plugin
        Remove if not implemented"""
        pass

Field Documentation

title

module.packetDump.BoswatchModule.title