NetMsgs.NetMsgsLib Namespace Reference

NetMsgs Run-Time Library Packing and Unpacking Base Module. More...

Functions
def	GetNativeByteOrder ()
def	PackBool (val, endian='big')
def	PackChar (val, endian='big')
def	PackU8 (val, endian='big')
def	PackS8 (val, endian='big')
def	PackU16 (val, endian='big')
def	PackS16 (val, endian='big')
def	PackU32 (val, endian='big')
def	PackS32 (val, endian='big')
def	PackU64 (val, endian='big')
def	PackS64 (val, endian='big')
def	PackF32 (val, endian='big')
def	PackF64 (val, endian='big')
def	PackP32 (val, endian='big')
def	PackP64 (val, endian='big')
def	PackString (val, count=None)
def	UnpackBool (buf, offset=0, endian='big')
def	UnpackChar (buf, offset=0, endian='big')
def	UnpackU8 (buf, offset=0, endian='big')
def	UnpackS8 (buf, offset=0, endian='big')
def	UnpackU16 (buf, offset=0, endian='big')
def	UnpackS16 (buf, offset=0, endian='big')
def	UnpackU32 (buf, offset=0, endian='big')
def	UnpackS32 (buf, offset=0, endian='big')
def	UnpackU64 (buf, offset=0, endian='big')
def	UnpackS64 (buf, offset=0, endian='big')
def	UnpackF32 (buf, offset=0, endian='big')
def	UnpackF64 (buf, offset=0, endian='big')
def	UnpackP32 (buf, offset=0, endian='big')
def	UnpackP64 (buf, offset=0, endian='big')
def	UnpackString (buf, count, offset=0)

Variables
string	EMsgBadId = "Identifier not an integer"
	bad integer identifier
string	EMsgEndian = "Invalid byte order value"
	bad endian
string	EMsgNoMem = "No space in buffer"
	buffer too small
string	EMsgFValType = "Invalid field value type"
	bad value type
string	EMsgNoFVal = "Field value not defined"
	value not defined
string	EMsgRange = "Field value out-of-range"
	bad range
string	EMsgIntRange = "Integer out-of-range"
	bad integer range
string	EMsgFPNRange = "Floating-point number out-of-range"
	bad FPN range
string	EMsgStringRange = "String length out-of-range"
	bad string length
string	EMsgStructRange = "Message/Struct field count out-of-range"
	bad struct count
string	EMsgVectorRange = "Vector length out-of-range"
	bad vector length
string	EMsgBufType = "Invalid buffer type"
	bad buffer
string	EMsgNoMsgDef = "Message definition not found"
	no msg definition
string	EMsgReqKeyword = "Required definition keyword not found"
	missing keyword
string	EMsgNoIndex = "Required index out of range"
	index out of range
string	EMsgBadMsg = "Bad message format"
	bad message

Detailed Description

NetMsgs Run-Time Library Packing and Unpacking Base Module.

LastChangedDate

2010-08-04 15:07:55 -0600 (Wed, 04 Aug 2010)

Rev

550

The NetsMsgsLib module provides basic packing and unpacking functions plus some byte and bit utilities.

See also

PyDoc Generated Documentation

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2010-2017. RoadNarrows LLC.
http://www.roadnarrows.com
All Rights Reserved

Function Documentation

def NetMsgs.NetMsgsLib.GetNativeByteOrder

(

)

Get the native byte order.

    Return:
      'big' or 'little'

Definition at line 140 of file NetMsgsLib.py.

References NetMsgs.NetMsgsLib.PackU16().

Referenced by NetMsgs.NetMsgsLib.PackP64(), NetMsgs.NetMsgsLib.PackS64(), NetMsgs.NetMsgsLib.PackU64(), NetMsgs.NetMsgsLib.UnpackP64(), NetMsgs.NetMsgsLib.UnpackS64(), and NetMsgs.NetMsgsLib.UnpackU64().

def GetNativeByteOrder():
  """ Get the native byte order.

      Return:
        'big' or 'little'
  """
  global _EndianNative
  if not _EndianNative:
    if PackU16(1, endian='native') == '\0x00\0x01':
      _EndianNative = 'big'
    else:
      _EndianNative = 'little'
  return _EndianNative

def NetMsgs.NetMsgsLib.PackBool	(		val,
			endian = 'big'
	)

Pack boolean into 1 byte.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 195 of file NetMsgsLib.py.

References NetMsgs.NetMsgsLib.PackU8().

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackBool().

def PackBool(val, endian='big'):
  """ Pack boolean into 1 byte.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  if val:
    return PackU8(1, endian=endian)
  else:
    return PackU8(0, endian=endian)

def NetMsgs.NetMsgsLib.PackChar	(		val,
			endian = 'big'
	)

Pack one 8-bit ASCII character into 1 byte.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 212 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackChar().

def PackChar(val, endian='big'):
  """ Pack one 8-bit ASCII character into 1 byte.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  try:
    return struct.pack('c', val)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _PackException('char', val, endian, inst)

def NetMsgs.NetMsgsLib.PackF32	(		val,
			endian = 'big'
	)

Pack a 32-bit floating-point number into 4 bytes.

    Is this guaranteed to be in IEEE 745 32-bit format?

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 390 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackF32().

def PackF32(val, endian='big'):
  """ Pack a 32-bit floating-point number into 4 bytes.

      Is this guaranteed to be in IEEE 745 32-bit format?

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  try:
    return struct.pack(_EndianCode[endian]+'f', val)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _PackException('f32', val, endian, inst)

def NetMsgs.NetMsgsLib.PackF64	(		val,
			endian = 'big'
	)

Pack a 64-bit floating-point number into 8 bytes.

    Is this guaranteed to be in IEEE 745 64-bit format?
    Will this pack into 8 bytes on 32-bit architectures?

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 409 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackF64().

def PackF64(val, endian='big'):
  """ Pack a 64-bit floating-point number into 8 bytes.

      Is this guaranteed to be in IEEE 745 64-bit format?
      Will this pack into 8 bytes on 32-bit architectures?

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  try:
    return struct.pack(_EndianCode[endian]+'d', val)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _PackException('f64', val, endian, inst)

def NetMsgs.NetMsgsLib.PackP32	(		val,
			endian = 'big'
	)

Pack a 32-bit floating-point number into 4 bytes.

    Note:
      Pointers are really foreign to python. However, a python application
      may have a linked c library that requires it. And NetMsgs supports it.

    Note:
      Pointers are always packed in native byte order.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 429 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackP32().

def PackP32(val, endian='big'):
  """ Pack a 32-bit floating-point number into 4 bytes.

      Note:
        Pointers are really foreign to python. However, a python application
        may have a linked c library that requires it. And NetMsgs supports it.

      Note:
        Pointers are always packed in native byte order.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  if struct.calcsize('L') == 4:
    try:
      return struct.pack(_EndianCode['native']+'L', val)
    except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
      _PackException('p32', val, endian, inst)
  else:
    msb = val >> 32
    lsb = val & 0xffffffff
    if msb != 0:
      warnings.warn("pack p32=%u: non-zero 4 MSB's truncated" % (val),
          RuntimeWarning)
    try:
      return struct.pack(_EndianCode['native']+'I', lsb)
    except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
      _PackException('p32', val, endian, inst)

def NetMsgs.NetMsgsLib.PackP64	(		val,
			endian = 'big'
	)

Pack a 64-bit floating-point number into 8 bytes.

    Note:
      Pointers are really foreign to python. However, a python application
      may have a linked c library that requires it. And NetMsgs supports it.

    Note:
      Pointers are always packed in native byte order.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 464 of file NetMsgsLib.py.

References NetMsgs.NetMsgsLib.GetNativeByteOrder(), and NetMsgs.NetMsgsLib.PackU32().

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackP64().

def PackP64(val, endian='big'):
  """ Pack a 64-bit floating-point number into 8 bytes.

      Note:
        Pointers are really foreign to python. However, a python application
        may have a linked c library that requires it. And NetMsgs supports it.

      Note:
        Pointers are always packed in native byte order.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  if struct.calcsize('L') == 8:
    try:
      return struct.pack(_EndianCode['native']+'Q', val)
    except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
      _PackException('p64', val, endian, inst)
  elif GetNativeByteOrder() == 'big':
    return PackU32(0, endian='big') + PackU32(val, endian='big')
  else: # little
    return PackU32(val, endian='little') + PackU32(0, endian='little')

def NetMsgs.NetMsgsLib.PackS16	(		val,
			endian = 'big'
	)

Pack a 16-bit signed integer into 2 bytes.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 284 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackS16().

def PackS16(val, endian='big'):
  """ Pack a 16-bit signed integer into 2 bytes.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  try:
    return struct.pack(_EndianCode[endian]+'h', val)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _PackException('s16', val, endian, inst)

def NetMsgs.NetMsgsLib.PackS32	(		val,
			endian = 'big'
	)

Pack a 32-bit signed integer into 4 bytes.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 318 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackS32(), and NetMsgs.NetMsgsLib.PackS64().

def PackS32(val, endian='big'):
  """ Pack a 32-bit signed integer into 4 bytes.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  try:
    return struct.pack(_EndianCode[endian]+'i', val)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _PackException('s32', val, endian, inst)

def NetMsgs.NetMsgsLib.PackS64	(		val,
			endian = 'big'
	)

Pack a 64-bit signed integer into 8 bytes.

    If native architectures only support 4 byte long long's, then the 4 MSBs
    are padded with zero's.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 361 of file NetMsgsLib.py.

References NetMsgs.NetMsgsLib.GetNativeByteOrder(), and NetMsgs.NetMsgsLib.PackS32().

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackS64().

def PackS64(val, endian='big'):
  """ Pack a 64-bit signed integer into 8 bytes.

      If native architectures only support 4 byte long long's, then the 4 MSBs
      are padded with zero's.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  if struct.calcsize('q') == 8:
    try:
      return struct.pack(_EndianCode[endian]+'q', val)
    except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
      _PackException('s64', val, endian, inst)
  if val & 0x80000000:
    msb = 0xffffffff      # negative value, extend sign
  else:
    msb = 0               # positive value
  if endian == 'big' or (endian == 'native' and GetNativeByteOrder() == 'big'):
    return PackS32(msb, endian='big') + PackS32(val, endian='big')
  else: # little
    return PackS32(val, endian='little') + PackS32(msb, endian='little')

def NetMsgs.NetMsgsLib.PackS8	(		val,
			endian = 'big'
	)

Pack an 8-bit signed integer into 1 byte.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 248 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackS8().

def PackS8(val, endian='big'):
  """ Pack an 8-bit signed integer into 1 byte.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  if (type(val) == str) and len(val) == 1:
    val = ord(val)
  try:
    return struct.pack(_EndianCode[endian]+'b', val)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _PackException('s8', val, endian, inst)

def NetMsgs.NetMsgsLib.PackString	(		val,
			count = None
	)

Pack a string.

    The endianess is ignore.
    The terminating Null is not packed.

    Parameters:
      val       - Field value.
      count     - Number of bytes to pack. None == all.

    Return:
      Binary string.

Definition at line 493 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibITV.NetMsgsITV.nmPackString(), and NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackString().

def PackString(val, count=None):
  """ Pack a string.

      The endianess is ignore.
      The terminating Null is not packed.

      Parameters:
        val       - Field value.
        count     - Number of bytes to pack. None == all.

      Return:
        Binary string.
  """
  try:
    n = len(val)
    if count is None:
      count = n
    elif count > n:
      val += (count-n) * '\x00'
  except (TypeError) as inst:
    _PackException('string', val, endian, inst)
  try:
    return struct.pack("%us" % (count), val)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _PackException('string', val, endian, inst)

def NetMsgs.NetMsgsLib.PackU16	(		val,
			endian = 'big'
	)

Pack a 16-bit unsigned integer into 2 bytes.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 267 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLib.GetNativeByteOrder(), NetMsgs.NetMsgsLibITV.NetMsgsITV.nmPackMsgHdr(), and NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackU16().

def PackU16(val, endian='big'):
  """ Pack a 16-bit unsigned integer into 2 bytes.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  try:
    return struct.pack(_EndianCode[endian]+'H', val)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _PackException('u16', val, endian, inst)

def NetMsgs.NetMsgsLib.PackU32	(		val,
			endian = 'big'
	)

Pack a 32-bit unsigned integer into 4 bytes.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 301 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackU32(), NetMsgs.NetMsgsLib.PackP64(), and NetMsgs.NetMsgsLib.PackU64().

def PackU32(val, endian='big'):
  """ Pack a 32-bit unsigned integer into 4 bytes.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  try:
    return struct.pack(_EndianCode[endian]+'I', val)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _PackException('u32', val, endian, inst)

def NetMsgs.NetMsgsLib.PackU64	(		val,
			endian = 'big'
	)

Pack a 64-bit unsigned integer into 8 bytes.

    If native architectures only support 4 byte long long's, then the 4 MSBs
    are padded with zero's.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 335 of file NetMsgsLib.py.

References NetMsgs.NetMsgsLib.GetNativeByteOrder(), and NetMsgs.NetMsgsLib.PackU32().

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackU64().

def PackU64(val, endian='big'):
  """ Pack a 64-bit unsigned integer into 8 bytes.

      If native architectures only support 4 byte long long's, then the 4 MSBs
      are padded with zero's.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  if struct.calcsize('Q') == 8:
    try:
      return struct.pack(_EndianCode[endian]+'Q', val)
    except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
      _PackException('u64', val, endian, inst)
  elif endian == 'big' or \
      (endian == 'native' and GetNativeByteOrder() == 'big'):
    return PackU32(0, endian='big') + PackU32(val, endian='big')
  else: # little
    return PackU32(val, endian='little') + PackU32(0, endian='little')

def NetMsgs.NetMsgsLib.PackU8	(		val,
			endian = 'big'
	)

Pack an 8-bit unsigned integer into 1 byte.

    Parameters:
      val       - Field value.
      endian    - Byte order.

    Return:
      Binary string.

Definition at line 229 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibITV.NetMsgsITV.nmPackFieldHdr(), NetMsgs.NetMsgsLibITV.NetMsgsITV.nmPackMsgHdr(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackPad(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackU8(), and NetMsgs.NetMsgsLib.PackBool().

def PackU8(val, endian='big'):
  """ Pack an 8-bit unsigned integer into 1 byte.

      Parameters:
        val       - Field value.
        endian    - Byte order.

      Return:
        Binary string.
  """
  if (type(val) == str) and len(val) == 1:
    val = ord(val)
  try:
    return struct.pack(_EndianCode[endian]+'B', val)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _PackException('u8', val, endian, inst)

def NetMsgs.NetMsgsLib.UnpackBool	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack boolean into 1 byte.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 562 of file NetMsgsLib.py.

References NetMsgs.NetMsgsLib.UnpackU8().

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackBool().

def UnpackBool(buf, offset=0, endian='big'):
  """ Unpack boolean into 1 byte.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  val, offset = UnpackU8(buf, offset=offset, endian=endian)
  if val:
    return True, offset
  else:
    return False, offset

def NetMsgs.NetMsgsLib.UnpackChar	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack one 8-bit ASCII character into 1 byte.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 581 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackChar().

def UnpackChar(buf, offset=0, endian='big'):
  """ Unpack one 8-bit ASCII character into 1 byte.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  try:
    return (struct.unpack_from(_EndianCode[endian]+'c', buf, offset)[0],
            offset+1)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _UnpackException('char', offset, endian, inst)

def NetMsgs.NetMsgsLib.UnpackF32	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack a 32-bit floating-point number into 4 bytes.

    Is this guaranteed to be in IEEE 745 32-bit format?

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 782 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackF32().

def UnpackF32(buf, offset=0, endian='big'):
  """ Unpack a 32-bit floating-point number into 4 bytes.

      Is this guaranteed to be in IEEE 745 32-bit format?

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  try:
    return (struct.unpack_from(_EndianCode[endian]+'f', buf, offset)[0],
            offset+4)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _UnpackException('f32', offset, endian, inst)

def NetMsgs.NetMsgsLib.UnpackF64	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack a 64-bit floating-point number into 8 bytes.

    Is this guaranteed to be in IEEE 745 64-bit format?
    Will this pack into 8 bytes on 32-bit architectures?

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 803 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackF64().

def UnpackF64(buf, offset=0, endian='big'):
  """ Unpack a 64-bit floating-point number into 8 bytes.

      Is this guaranteed to be in IEEE 745 64-bit format?
      Will this pack into 8 bytes on 32-bit architectures?

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  try:
    return (struct.unpack_from(_EndianCode[endian]+'d', buf, offset)[0],
            offset+8)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _UnpackException('f64', offset, endian, inst)

def NetMsgs.NetMsgsLib.UnpackP32	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack a 32-bit floating-point number into 4 bytes.

    Note:
      Pointers are really foreign to python. However, a python application
      may have a linked c library that requires it. And NetMsgs XML and
      run-time C library supports it.

    Note:
      Pointers are always unpacked in native byte order.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 825 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackP32().

def UnpackP32(buf, offset=0, endian='big'):
  """ Unpack a 32-bit floating-point number into 4 bytes.

      Note:
        Pointers are really foreign to python. However, a python application
        may have a linked c library that requires it. And NetMsgs XML and
        run-time C library supports it.

      Note:
        Pointers are always unpacked in native byte order.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  try:
    return (struct.unpack_from(_EndianCode['native']+'I', buf, offset)[0],
            offset+4)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _UnpackException('p32', offset, endian, inst)

def NetMsgs.NetMsgsLib.UnpackP64	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack a 64-bit floating-point number into 8 bytes.

    Note:
      Pointers are really foreign to python. However, a python application
      may have a linked c library that requires it. And NetMsgs supports it.

    Note:
      Pointers are always unpacked in native byte order.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 852 of file NetMsgsLib.py.

References NetMsgs.NetMsgsLib.GetNativeByteOrder(), and NetMsgs.NetMsgsLib.UnpackU32().

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackP64().

def UnpackP64(buf, offset=0, endian='big'):
  """ Unpack a 64-bit floating-point number into 8 bytes.

      Note:
        Pointers are really foreign to python. However, a python application
        may have a linked c library that requires it. And NetMsgs supports it.

      Note:
        Pointers are always unpacked in native byte order.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  if struct.calcsize('L') == 8:
    try:
      return (struct.unpack_from(_EndianCode[endian]+'L', buf, offset)[0],
              offset+8)
    except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
      _UnpackException('u8', offset, endian, inst)
  elif (endian == 'native') and (GetNativeByteOrder() == 'big'):
    msb, offset = UnpackU32(buf, offset=offset, endian='big')
    lsb, offset = UnpackU32(buf, offset=offset, endian='big')
  else: # little
    lsb, offset = UnpackU32(buf, offset=offset, endian='little')
    msb, offset = UnpackU32(buf, offset=offset, endian='little')
  if msb != 0:
    warnings.warn("unpack p64=0x%08x%08x: non-zero 4 MSB's truncated" % \
        (msb, lsb), RuntimeWarning)
  return (lsb, offset)

def NetMsgs.NetMsgsLib.UnpackS16	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack a 16-bit signed integer into 2 bytes.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 657 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackS16().

def UnpackS16(buf, offset=0, endian='big'):
  """ Unpack a 16-bit signed integer into 2 bytes.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  try:
    return (struct.unpack_from(_EndianCode[endian]+'h', buf, offset)[0],
            offset+2)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _UnpackException('s16', offset, endian, inst)

def NetMsgs.NetMsgsLib.UnpackS32	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack a 32-bit signed integer into 4 bytes.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 695 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackS32().

def UnpackS32(buf, offset=0, endian='big'):
  """ Unpack a 32-bit signed integer into 4 bytes.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  try:
    return (struct.unpack_from(_EndianCode[endian]+'i', buf, offset)[0],
            offset+4)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _UnpackException('s32', offset, endian, inst)

def NetMsgs.NetMsgsLib.UnpackS64	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack a 64-bit signed integer into 8 bytes.

    If native architectures only support 4 byte long long's, then the 4 MSBs
    are padded with zero's.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 748 of file NetMsgsLib.py.

References NetMsgs.NetMsgsLib.GetNativeByteOrder(), and NetMsgs.NetMsgsLib.UnpackU32().

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackS64().

def UnpackS64(buf, offset=0, endian='big'):
  """ Unpack a 64-bit signed integer into 8 bytes.

      If native architectures only support 4 byte long long's, then the 4 MSBs
      are padded with zero's.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  if struct.calcsize('q') == 8:
    try:
      return (struct.unpack_from(_EndianCode[endian]+'q', buf, offset)[0],
              offset+8)
    except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
      _UnpackException('s64', offset, endian, inst)
  elif endian == 'big' or \
      (endian == 'native' and GetNativeByteOrder() == 'big'):
    msb, offset = UnpackU32(buf, offset=offset, endian='big')
    lsb, offset = UnpackU32(buf, offset=offset, endian='big')
  else: # little
    lsb, offset = UnpackU32(buf, offset=offset, endian='little')
    msb, offset = UnpackU32(buf, offset=offset, endian='little')
  if (msb != 0) and (msb != 0xffffffff): # test zero or sign extended msb
    warnings.warn("unpack s64=0x%08x%08x: non-zero 4 MSB's truncated" % \
        (msb, lsb), RuntimeWarning)
  return (lsb, offset)

def NetMsgs.NetMsgsLib.UnpackS8	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack an 8-bit signed integer into 1 byte.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 619 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackS8().

def UnpackS8(buf, offset=0, endian='big'):
  """ Unpack an 8-bit signed integer into 1 byte.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  try:
    return (struct.unpack_from(_EndianCode[endian]+'b', buf, offset)[0],
            offset+1)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _UnpackException('s8', offset, endian, inst)

def NetMsgs.NetMsgsLib.UnpackString	(		buf,
			count,
			offset = 0
	)

Unpack a string.

    The endianess is ignore.
    The terminating Null is not packed.

    Parameters:
      buf       - Input packed buffer.
      count     - Number of bytes to unpack.
      offset    - Offset in buffer.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 889 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibITV.NetMsgsITV.nmUnpackString(), and NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackString().

def UnpackString(buf, count, offset=0):
  """ Unpack a string.

      The endianess is ignore.
      The terminating Null is not packed.

      Parameters:
        buf       - Input packed buffer.
        count     - Number of bytes to unpack.
        offset    - Offset in buffer.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  try:
    return (struct.unpack_from("%us" % (count), buf, offset)[0], offset+count)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _UnpackException('string', offset, 'big', inst)

def NetMsgs.NetMsgsLib.UnpackU16	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack a 16-bit unsigned integer into 2 bytes.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 638 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibITV.NetMsgsITV.nmUnpackMsgHdr(), and NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackU16().

def UnpackU16(buf, offset=0, endian='big'):
  """ Unpack a 16-bit unsigned integer into 2 bytes.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  try:
    return (struct.unpack_from(_EndianCode[endian]+'H', buf, offset)[0],
            offset+2)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _UnpackException('u16', offset, endian, inst)

def NetMsgs.NetMsgsLib.UnpackU32	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack a 32-bit unsigned integer into 4 bytes.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 676 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackU32(), NetMsgs.NetMsgsLib.UnpackP64(), NetMsgs.NetMsgsLib.UnpackS64(), and NetMsgs.NetMsgsLib.UnpackU64().

def UnpackU32(buf, offset=0, endian='big'):
  """ Unpack a 32-bit unsigned integer into 4 bytes.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  try:
    return (struct.unpack_from(_EndianCode[endian]+'I', buf, offset)[0],
            offset+4)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _UnpackException('u32', offset, endian, inst)

def NetMsgs.NetMsgsLib.UnpackU64	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack a 64-bit unsigned integer into 8 bytes.

    If native architectures only support 4 byte long long's, then the 4 MSBs
    are padded with zero's.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 714 of file NetMsgsLib.py.

References NetMsgs.NetMsgsLib.GetNativeByteOrder(), and NetMsgs.NetMsgsLib.UnpackU32().

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackU64().

def UnpackU64(buf, offset=0, endian='big'):
  """ Unpack a 64-bit unsigned integer into 8 bytes.

      If native architectures only support 4 byte long long's, then the 4 MSBs
      are padded with zero's.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  if struct.calcsize('Q') == 8:
    try:
      return (struct.unpack_from(_EndianCode[endian]+'Q', buf, offset)[0],
              offset+8)
    except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
      _UnpackException('u64', offset, endian, inst)
  elif endian == 'big' or \
      (endian == 'native' and GetNativeByteOrder() == 'big'):
    msb, offset = UnpackU32(buf, offset=offset, endian='big')
    lsb, offset = UnpackU32(buf, offset=offset, endian='big')
  else: # little
    lsb, offset = UnpackU32(buf, offset=offset, endian='little')
    msb, offset = UnpackU32(buf, offset=offset, endian='little')
  if msb != 0:
    warnings.warn("unpack u64=0x%08x%08x: non-zero 4 MSB's truncated" % \
        (msb, lsb), RuntimeWarning)
  return (lsb, offset)

def NetMsgs.NetMsgsLib.UnpackU8	(		buf,
			offset = 0,
			endian = 'big'
	)

Unpack an 8-bit unsigned integer into 1 byte.

    Parameters:
      buf       - Input packed buffer.
      offset    - Offset in buffer.
      endian    - Byte order.

    Return:
      2-tuple of unpacked value, new buffer offset.

Definition at line 600 of file NetMsgsLib.py.

Referenced by NetMsgs.NetMsgsLibITV.NetMsgsITV.nmUnpackFieldHdr(), NetMsgs.NetMsgsLibITV.NetMsgsITV.nmUnpackMsgHdr(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackU8(), and NetMsgs.NetMsgsLib.UnpackBool().

def UnpackU8(buf, offset=0, endian='big'):
  """ Unpack an 8-bit unsigned integer into 1 byte.

      Parameters:
        buf       - Input packed buffer.
        offset    - Offset in buffer.
        endian    - Byte order.

      Return:
        2-tuple of unpacked value, new buffer offset.
  """
  try:
    return (struct.unpack_from(_EndianCode[endian]+'B', buf, offset)[0],
            offset+1)
  except (KeyError, TypeError, DeprecationWarning, struct.error) as inst:
    _UnpackException('u8', offset, endian, inst)