class BitmapInval(exceptions.Exception)¶

Exception for an invalid bit number

class DateStr(__builtin__.float)¶

Floating point object which is displayed as a date

Methods defined here:
---------------------

__str__(self)

class Enum(__builtin__.int)¶

Enum base object
This should only be used as a base class where the class attributes
should be initialized

Methods defined here:
---------------------

__str__(self)
Informal string representation, display value using the mapping
dictionary provided as a class attribute

Static methods defined here:
----------------------------

__new__(cls, unpack)
Constructor which checks if integer is a valid enum value

class EnumInval(exceptions.Exception)¶

Exception for an invalid enum value

class IntHex(__builtin__.int)¶

Integer object which is displayed in hex

Methods defined here:
---------------------

__repr__ = __str__(self)

__str__(self)

class LongHex(__builtin__.long)¶

Long integer object which is displayed in hex

Methods defined here:
---------------------

__repr__ = __str__(self)

__str__(self)

class OptionFlags(baseobj.BaseObj)¶

OptionFlags base object
This base class is used to have a set of raw flags represented by an
integer and splits every bit into an object attribute according to the
class attribute _bitnames where the key is the bit number and the value
is the attribute name.
This should only be used as a base class where the class attribute
_bitnames should be initialized. The class attribute _reversed can
also be initialized to reverse the _bitnames so the first bit becomes
the last, e.g., _reversed = 31, bits are reversed on a 32 bit integer
so 0 becomes 31, 1 becomes 30, etc.
Usage:


    from packet.utils import OptionFlags


    class MyFlags(OptionFlags):


        _bitnames = {0:"bit0", 1:"bit1", 2:"bit2", 3:"bit3"}


    x = MyFlags(10) # 10 = 0b1010


    The attributes of object are:


        x.rawflags = 10, # Original raw flags


        x.bit0     = 0,


        x.bit1     = 1,


        x.bit2     = 0,


        x.bit3     = 1,

Methods defined here:
---------------------

__init__(self, options)
Initialize object's private data.

str_flags(self)
Display the flag names which are set, e.g., in the above example
the output will be "bit1,bit3" (bit1=1, bit3=1)
Use "__str__ = OptionFlags.str_flags" to have it as the default
string representation

class RPCload(baseobj.BaseObj)¶

RPC load base object
This is used as a base class for an RPC payload object

Methods defined here:
---------------------

__str__(self)
Informal string representation

rpc_str(self, name=None)
Display RPC string

class ShortHex(__builtin__.int)¶

Short integer object which is displayed in hex

Methods defined here:
---------------------

__repr__ = __str__(self)

__str__(self)

class StrHex(__builtin__.str)¶

String object which is displayed in hex

Methods defined here:
---------------------

__str__(self)

bitmap_dict(unpack, bitmap, func_map, name_map=None)¶

Returns a dictionary where the key is the bit number given by bitmap and the value is the decoded value by evaluating the function used for that specific bit number