packet.utils (3) - Linux Manuals
packet.utils: Pktt utilities module
NAME
packet.utils - Pktt utilities moduleDESCRIPTION
The Packet trace utilities module has classes which augment functionality of basic data types like displaying integers as their hex equivalent. It also includes an Enum base class which displays the integer as its string representation given by a mapping dictionary. There is also a class to be used as a base class for an RPC payload object. This module also includes some module variables to change how certain objects are displayed.
CLASSES
class BitmapInval(exceptions.Exception)
Exception for an invalid bit number
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: --------------------- __str__(self)
class LongHex(__builtin__.long)
Long integer object which is displayed in hex Methods defined here: --------------------- __str__(self)
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 StrHex(__builtin__.str)
String object which is displayed in hex Methods defined here: --------------------- __str__(self)
FUNCTIONS
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
-
- unpack:
- Unpack object
- bitmap:
- Unsigned integer where a value must be decoded for every bit that is set, starting from the least significant bit
- func_map:
- Dictionary which maps a bit number to the function to be used for decoding the value for that bit number. The function must have the "unpack" object as the only argument
- name_map:
- Dictionary which maps a bit number to a bit name. If this is given the resulting dictionary will have a bit name for a key instead of the bit number
BUGS
No known bugs.AUTHOR
Jorge Mora (mora [at] netapp.com)