boswatch.packet.Packet Class Reference

Class implementation of an BOSWatch packet. More...

Public Member Functions
	__init__ (self, bwPacket=None)
	Build a new BOSWatch packet or copy existing data in it.
	__str__ (self)
	Return the intern _packet dict as string.
	set (self, fieldName, value)
	Set a field in the intern _packet dict.
	get (self, fieldName)
	Returns the value from a single field.
	printInfo (self)
	Print a info message to the log on INFO level.

Protected Attributes
	_packet

Detailed Description

Class implementation of an BOSWatch packet.

Constructor & Destructor Documentation

__init__()

boswatch.packet.Packet.__init__	(		self,
			bwPacket = None
	)

Build a new BOSWatch packet or copy existing data in it.

Parameters

bwPacket

Existing data to copy

    def __init__(self, bwPacket=None):
        r"""!Build a new BOSWatch packet or copy existing data in it
 
        @param bwPacket: Existing data to copy"""
        if bwPacket is None:
            logging.debug("create new bwPacket")
            self._packet = {"timestamp": time.time()}
        else:
            logging.debug("create bwPacket from string")
            try:
                self._packet = ast.literal_eval(str(bwPacket).strip())
            except (ValueError, SyntaxError) as e:
                logging.error("Failed to parse bwPacket (Size: %d): %s | Data: %.1000s", len(str(bwPacket)), e, str(bwPacket).strip())
                raise  # forward it so the caller can handle it
 

Member Function Documentation

__str__()

boswatch.packet.Packet.__str__

(

self

)

Return the intern _packet dict as string.

    def __str__(self):
        r"""!Return the intern _packet dict as string"""
        return str(self._packet)
 

set()

boswatch.packet.Packet.set	(		self,
			fieldName,
			value
	)

Set a field in the intern _packet dict.

Parameters

fieldName	Name of the data to set
value	Value to set

    def set(self, fieldName, value):
        r"""!Set a field in the intern _packet dict
 
        @param fieldName: Name of the data to set
        @param value: Value to set"""
        self._packet[fieldName] = str(value)
 

get()

boswatch.packet.Packet.get	(		self,
			fieldName
	)

Returns the value from a single field.

If field not existing None is returned

Parameters

fieldName

Name of the field

Returns

Value or None

    def get(self, fieldName):
        r"""!Returns the value from a single field.
        If field not existing `None` is returned
 
        @param fieldName: Name of the field
        @return Value or None"""
        try:
            return str(self._packet[fieldName])
        except:
            logging.warning("field not found: %s", fieldName)
            return None
 

printInfo()

boswatch.packet.Packet.printInfo

(

self

)

Print a info message to the log on INFO level.

Contains the most useful info about this packet.

Todo:

not complete yet - must be edit to print nice formatted messages on console

    def printInfo(self):
        r"""!Print a info message to the log on INFO level.
        Contains the most useful info about this packet.
        @todo not complete yet - must be edit to print nice formatted messages on console
        """
        logging.info("[%s]", self.get("mode"))

Field Documentation

_packet

boswatch.packet.Packet._packet

protected