nmLibPackFlat.c File Reference

Flat message packing/unpacking definitions. More...

#include <stdio.h>
#include <stdlib.h>
#include <libgen.h>
#include <string.h>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/netmsgs.h"
#include "nmLibInternal.h"

Go to the source code of this file.

Functions
static NMPackFunc_T	nmLookupFlatPacker (NMFType_T eFType)
	Lookup Flat packer function, given the message field type. More...
static NMUnpackFunc_T	nmLookupFlatUnpacker (NMFType_T eFType)
	Lookup Flat unpacker function, given the message field type. More...
static int	nmPackFlatStream (const NMMsgDef_T *pMsgDef, void *pStruct, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a Flat message. More...
static int	nmUnpackFlatStream (const NMMsgDef_T *pMsgDef, byte_t buf[], size_t uMsgLen, void *pStruct, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an Flat byte stream. More...
static int	nmPackFlatPad (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack pad bytes into the message buffer. More...
static int	nmPackFlatBool (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a boolean into an 8-bit Flat field into the message buffer. More...
static int	nmPackFlatU8 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack an unsigned 8-bit Flat field into the message buffer. More...
static int	nmPackFlatS8 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a signed 8-bit Flat field into the message buffer. More...
static int	nmPackFlatU16 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack an unsigned 16-bit Flat field into the message buffer. More...
static int	nmPackFlatS16 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a signed 16-bit Flat field into the message buffer. More...
static int	nmPackFlatU32 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack an unsigned 32-bit Flat field into the message buffer. More...
static int	nmPackFlatS32 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a signed 32-bit Flat field into the message buffer. More...
static int	nmPackFlatU64 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack an unsigned 64-bit Flat field into the message buffer. More...
static int	nmPackFlatS64 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a signed 64-bit Flat field into the message buffer. More...
static int	nmPackFlatF32 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a 32-bit floating-point number Flat field into the message buffer. More...
static int	nmPackFlatF64 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a 64-bit floating-point number Flat field into the message buffer. More...
static int	nmPackFlatP32 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a 32-bit pointer Flat field into the message buffer. More...
static int	nmPackFlatP64 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a 64-bit pointer Flat field into the message buffer. More...
static int	nmPackFlatString (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack null-terminated, fixed length string Flat field into the message buffer. More...
static int	nmPackFlatStruct (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a structure Flat field into the message buffer. More...
static int	nmPackFlatVector (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack variable length vector Flat field into the message buffer. More...
static int	nmUnpackFlatPad (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack pad byte from the message buffer. More...
static int	nmUnpackFlatBool (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an unsigned 8-bit boolean Flat field from the message buffer. More...
static int	nmUnpackFlatU8 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an unsigned 8-bit Flat field from the message buffer. More...
static int	nmUnpackFlatS8 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a signed 8-bit Flat field from the message buffer. More...
static int	nmUnpackFlatU16 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an unsigned 16-bit Flat field from the message buffer. More...
static int	nmUnpackFlatS16 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a signed 16-bit Flat field from the message buffer. More...
static int	nmUnpackFlatU32 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an unsigned 32-bit Flat field from the message buffer. More...
static int	nmUnpackFlatS32 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a signed 32-bit Flat field from the message buffer. More...
static int	nmUnpackFlatU64 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an unsigned 64-bit Flat field from the message buffer. More...
static int	nmUnpackFlatS64 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a signed 64-bit Flat field from the message buffer. More...
static int	nmUnpackFlatF32 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a 32-bit floating-point number Flat field from the message buffer. More...
static int	nmUnpackFlatF64 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a 64-bit floating-point number Flat field from the message buffer. More...
static int	nmUnpackFlatP32 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a 32-bit pointer Flat field from the message buffer. More...
static int	nmUnpackFlatP64 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a 64-bit pointer Flat field from the message buffer. More...
static int	nmUnpackFlatString (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack variable length string Flat field from the message buffer. More...
static int	nmUnpackFlatStruct (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack structure Flat field from the message buffer. More...
static int	nmUnpackFlatVector (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack variable length vector Flat field from the message buffer. More...
int	nmPackFlatMsg (const NMMsgDef_T *pMsgDef, void *pStruct, byte_t buf[], size_t bufSize, NMEndian_T eEndian)
	Pack an Flat message. More...
int	nmPackFlatMsgDebug (const NMMsgDef_T *pMsgDef, void *pStruct, byte_t buf[], size_t bufSize, NMEndian_T eEndian)
	Pack an Flat message, tracing message packing to stderr. More...
int	nmUnpackFlatMsg (const NMMsgDef_T *pMsgDef, byte_t buf[], size_t uMsgLen, void *pStruct, NMEndian_T eEndian)
	Unpack a Flat message. More...
int	nmUnpackFlatMsgDebug (const NMMsgDef_T *pMsgDef, byte_t buf[], size_t uMsgLen, void *pStruct, NMEndian_T eEndian)
	Unpack a Flat message, tracing unpacking to stderr. More...

Variables
static NMLookupTblEntry_T	NMFlatLookupTbl []

Detailed Description

Flat message packing/unpacking definitions.

LastChangedDate

2010-02-16 08:12:53 -0700 (Tue, 16 Feb 2010)

Rev

248

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

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

Definition in file nmLibPackFlat.c.

Function Documentation

static NMPackFunc_T nmLookupFlatPacker ( NMFType_T  eFType )

static

Lookup Flat packer function, given the message field type.

Parameters

eFType

Message field type.

Returns

Returns packer function on success, NULL on failure.

Definition at line 1337 of file nmLibPackFlat.c.

References NMLookupTblEntry_T::m_fnPack, NM_ECODE_INTERNAL, NMHashFType(), NMHashNoIdx, NMLIB_ASCII_FTYPE, and NMLIB_ERROR.

Referenced by nmPackFlatStream(), and nmPackFlatVector().

{
  int idx;
 
  idx = NMHashFType(eFType);

  if( (idx != NMHashNoIdx) && (idx < arraysize(NMFlatLookupTbl)) )
  {
    if( NMFlatLookupTbl[idx].m_eFType == eFType )
    {
      return NMFlatLookupTbl[idx].m_fnPack;
    }
    else
    {
      NMLIB_ERROR(NM_ECODE_INTERNAL,
        "hashed eFtype='%c'(0x%02x) != tbl[%d].m_eFType='%c'(0x%02x)",
        NMLIB_ASCII_FTYPE(eFType), eFType,
        idx, NMLIB_ASCII_FTYPE(NMFlatLookupTbl[idx].m_eFType),
        NMFlatLookupTbl[idx].m_eFType);
      return NULL;
    }
  }
  else
  {
    return NULL;
  }
}

static NMUnpackFunc_T nmLookupFlatUnpacker ( NMFType_T  eFType )

static

Lookup Flat unpacker function, given the message field type.

Parameters

eFType

Message field type.

Returns

Returns unpacker function on success, NULL on failure.

Definition at line 1372 of file nmLibPackFlat.c.

References NMLookupTblEntry_T::m_fnUnpack, NM_ECODE_INTERNAL, NMHashFType(), NMHashNoIdx, NMLIB_ASCII_FTYPE, and NMLIB_ERROR.

Referenced by nmUnpackFlatStream(), and nmUnpackFlatVector().

{
  int idx;
 
  idx = NMHashFType(eFType);

  if( (idx != NMHashNoIdx) && (idx < arraysize(NMFlatLookupTbl)) )
  {
    if( NMFlatLookupTbl[idx].m_eFType == eFType )
    {
      return NMFlatLookupTbl[idx].m_fnUnpack;
    }
    else
    {
      NMLIB_ERROR(NM_ECODE_INTERNAL,
        "hashed eFtype='%c'(0x%02x) != tbl[%d].m_eFType='%c'(0x%02x)",
        NMLIB_ASCII_FTYPE(eFType), eFType,
        idx, NMLIB_ASCII_FTYPE(NMFlatLookupTbl[idx].m_eFType),
        NMFlatLookupTbl[idx].m_eFType);
      return NULL;
    }
  }
  else
  {
    return NULL;
  }
}

static int nmPackFlatBool ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a boolean into an 8-bit Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 120 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmPackBool().

{
  bool_t  val;    // constrained field value
  int     n;      // byte count/error code

  val = *((bool_t *)pVal);

  // pack field value
  n = nmPackBool(val, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%s", (val? "true": "false"));

  return n;
}

static int nmPackFlatF32 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a 32-bit floating-point number Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 387 of file nmLibPackFlat.c.

References NM_OK, NMLIB_TRACE_FIELD, nmPackF32(), and nmSetF32().

{
  float   val;  // constrained field value
  int     n;    // byte count/error code

  // set field value
  if( (n = nmSetF32(pFieldDef, pVal, &val)) != NM_OK )
  {
    return n;
  }

  // pack field value
  n = nmPackF32(val, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%f", val);

  return n;
}

static int nmPackFlatF64 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a 64-bit floating-point number Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 418 of file nmLibPackFlat.c.

References NM_OK, NMLIB_TRACE_FIELD, nmPackF64(), and nmSetF64().

{
  double  val;  // constrained field value
  int     n;    // byte count/error code

  // set field value
  if( (n = nmSetF64(pFieldDef, pVal, &val)) != NM_OK )
  {
    return n;
  }

  // pack field value
  n = nmPackF64(val, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%e", val);

  return n;
}

int nmPackFlatMsg	(	const NMMsgDef_T *	pMsgDef,
		void *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		NMEndian_T	eEndian
	)

Pack an Flat message.

Parameters

	pMsgDef	Pointer to message definition.
[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 1417 of file nmLibPackFlat.c.

References NMCtl_T::m_bNoHdr, NMCTL_INIT_DECL, and nmPackFlatStream().

Referenced by nmUnpackPointer().

{
  NMCtl_T   ctl = NMCTL_INIT_DECL;
  int       n;      // byte count/error code

  ctl.m_bNoHdr  = true;

  // pack stream
  n = nmPackFlatStream(pMsgDef, pStruct, buf, bufSize, eEndian, &ctl);

  return n;
}

int nmPackFlatMsgDebug	(	const NMMsgDef_T *	pMsgDef,
		void *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		NMEndian_T	eEndian
	)

Pack an Flat message, tracing message packing to stderr.

Parameters

	pMsgDef	Pointer to message definition.
[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 1446 of file nmLibPackFlat.c.

References NMCtl_T::m_bNoHdr, NMCtl_T::m_bTrace, _nm_msg_def_struct::m_eMsgId, _nm_msg_def_struct::m_sMsgName, _nm_msg_def_struct::m_uCount, NMCTL_INIT_DECL, nmPackFlatStream(), and nmPrintBuf().

Referenced by nmUnpackPointer().

{
  NMCtl_T   ctl = NMCTL_INIT_DECL;
  int       n;      // byte count/error code

  ctl.m_bNoHdr  = true;
  ctl.m_bTrace  = true;

  // trace
  fprintf(stderr, "\n--- Packing Flat Message %s(%u): field_count=%zu\n",
                  pMsgDef->m_sMsgName, pMsgDef->m_eMsgId, pMsgDef->m_uCount);

  // pack stream
  n = nmPackFlatStream(pMsgDef, pStruct, buf, bufSize, eEndian, &ctl);

  // trace final buffer
  if( n > 0 )
  {
    fprintf(stderr, "Output Buffer (%zu bytes):\n", (size_t)n);
    nmPrintBuf(stderr, NULL, buf, (size_t)n, 16, 0);
    fprintf(stderr, "\n");
  }

  return n;
}

static int nmPackFlatP32 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a 32-bit pointer Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 448 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmPackP32().

{
  int       n;    // byte count/error code

  // pack field value
  n = nmPackP32(pVal, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%p", *((ulong_t *)pVal));

  return n;
}

static int nmPackFlatP64 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a 64-bit pointer Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 471 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmPackP64().

{
  int       n;    // byte count/error code

  // pack field value
  n = nmPackP64(pVal, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%p", *((ulong_t *)pVal));

  return n;
}

static int nmPackFlatPad ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack pad bytes into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 89 of file nmLibPackFlat.c.

References _nm_field_def_struct::m_eFId, NMFieldThis_T::m_pad, _nm_field_def_struct::m_this, NMFieldThisPad_T::m_uCount, NM_ECODE_NOMEM, NMFVAL_PAD, NMLIB_RAISE_FIELD_ERROR, and NMLIB_TRACE_FIELD.

{
  size_t    uCount = pFieldDef->m_this.m_pad.m_uCount;

  // pack pad bytes
  if( uCount <= bufSize )
  {
    memset(buf, NMFVAL_PAD, uCount);  
    NMLIB_TRACE_FIELD(NULL, buf, uCount, pCtl, "pad(%u)", pFieldDef->m_eFId);
    return (int)uCount;
  }

  // no more space in buffer for pad bytes
  else
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < pad_count=%zu", bufSize, uCount);
  }
}

static int nmPackFlatS16 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a signed 16-bit Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 236 of file nmLibPackFlat.c.

References NM_OK, NMLIB_TRACE_FIELD, nmPackS16(), and nmSetS16().

{
  short   val;  // constrained field value
  int     n;    // byte count/error code

  // set field value
  if( (n = nmSetS16(pFieldDef, pVal, &val)) != NM_OK )
  {
    return n;
  }

  // pack field value
  n = nmPackS16(val, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%hd", val);

  return n;
}

static int nmPackFlatS32 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a signed 32-bit Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 296 of file nmLibPackFlat.c.

References NM_OK, NMLIB_TRACE_FIELD, nmPackS32(), and nmSetS32().

{
  int   val;  // constrained field value
  int   n;    // byte count/error code

  // set field value
  if( (n = nmSetS32(pFieldDef, pVal, &val)) != NM_OK )
  {
    return n;
  }

  // pack field value
  n = nmPackS32(val, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%d", val);

  return n;
}

static int nmPackFlatS64 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a signed 64-bit Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 356 of file nmLibPackFlat.c.

References NM_OK, NMLIB_TRACE_FIELD, nmPackS64(), and nmSetS64().

{
  long long val;  // constrained field value
  int       n;    // byte count/error code

  // set field value
  if( (n = nmSetS64(pFieldDef, pVal, &val)) != NM_OK )
  {
    return n;
  }

  // pack field value
  n = nmPackS64(val, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%lld", val);

  return n;
}

static int nmPackFlatS8 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a signed 8-bit Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 176 of file nmLibPackFlat.c.

References NM_OK, NMLIB_TRACE_FIELD, nmPackS8(), and nmSetS8().

{
  signed char val;  // constrained field value
  int         n;    // byte count/error code

  // try to set field value
  if( (n = nmSetS8(pFieldDef, pVal, &val)) != NM_OK )
  {
    return n;
  }

  // pack field value
  n = nmPackS8(val, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%hhd", val);

  return n;
}

static int nmPackFlatStream ( const NMMsgDef_T *  pMsgDef, void *  pStruct, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a Flat message.

Parameters

	pMsgDef	Pointer to message definition.
[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Pointer to Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 690 of file nmLibPackFlat.c.

References _nm_field_def_struct::m_eFType, _nm_msg_def_struct::m_eMsgId, _nm_msg_def_struct::m_pFields, _nm_field_def_struct::m_uOffset, NM_ECODE_FTYPE, NM_ECODE_NOMEM, NMFTypePad, NMLIB_ASCII_FTYPE, NMLIB_RAISE_ERROR, NMLIB_RAISE_FIELD_ERROR, and nmLookupFlatPacker().

Referenced by nmPackFlatMsg(), nmPackFlatMsgDebug(), and nmPackFlatStruct().

{
  size_t              uFieldNum;        // field instance number (not id)
  const NMFieldDef_T *pFieldDef;        // working field definition pointer
  NMPackFunc_T        fnPack;           // field packing function
  void               *pVal;             // pointer to field value
  int                 n = 0;            // byte count/error code
  int                 k;                // subbyte count/error code

  //
  // Pack message fields
  //
  for(uFieldNum=0, pFieldDef=pMsgDef->m_pFields;
      uFieldNum < pMsgDef->m_uCount;
      ++uFieldNum, ++pFieldDef)
  {
    if( n < bufSize )
    {
      if( pFieldDef->m_eFType == NMFTypePad )
      {
        pVal    = NULL;
      }

      else
      {
        pVal    = pStruct + pFieldDef->m_uOffset;
      }

      fnPack  = nmLookupFlatPacker(pFieldDef->m_eFType);

      if( fnPack == NULL )
      {
        NMLIB_RAISE_FIELD_ERROR(NM_ECODE_FTYPE, pFieldDef,
               "ftype='%c'(0x%02x).",
                NMLIB_ASCII_FTYPE(pFieldDef->m_eFType), pFieldDef->m_eFType);
      }

      k = fnPack(pFieldDef, pVal, &buf[n], bufSize-(size_t)n, eEndian, pCtl);

      if( k < 0 )
      {
        return k;
      }
    }

    else
    {
      NMLIB_RAISE_ERROR(NM_ECODE_NOMEM,
        "buf_size=%zu, msgid=%u", bufSize, pMsgDef->m_eMsgId);
    }

    n += k;
  }

  return n;
}

static int nmPackFlatString ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack null-terminated, fixed length string Flat field into the message buffer.

Note

The null character is not packed.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 497 of file nmLibPackFlat.c.

References NMFieldThisString_T::m_sConst, NMFieldThis_T::m_string, _nm_field_def_struct::m_this, NMFieldThisString_T::m_uMaxCount, NM_ECODE_NOMEM, NM_ECODE_RANGE, NMLIB_RAISE_FIELD_ERROR, and NMLIB_TRACE_FIELD.

{
  const char   *sVal;       // string field value pointer
  const char   *sConst;     // string constant value, if any
  size_t        uMaxCount;  // string maximum packed size
  size_t        uCount;     // string length

  sVal      = (const char *)pVal;                     // override void *
  sConst    = pFieldDef->m_this.m_string.m_sConst;
  uMaxCount = pFieldDef->m_this.m_string.m_uMaxCount;

  if( sConst != NULL )
  {
    sVal = sConst;
  }

  uCount = strlen(sVal);            // string length w/o null

  // string length exceeds maximum
  if( uCount > uMaxCount )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_RANGE, pFieldDef,
        "char_count=%zu > max_count=%zu.", uCount, uMaxCount);
  }

  // no more space in buffer for string
  else if( uMaxCount > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < str_max_len=%zu.", bufSize, uMaxCount);
  }

  // copy string field value
  memcpy(buf, sVal, uCount);

  // pad with zeros
  if( uCount < uMaxCount )
  {
    memset(&buf[uCount], 0, uMaxCount-uCount);
  }

  NMLIB_TRACE_FIELD(pFieldDef, buf, uMaxCount, pCtl, "'%s'", sVal);

  return (int)uMaxCount;
}

static int nmPackFlatStruct ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a structure Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 554 of file nmLibPackFlat.c.

References _nm_msg_def_struct::m_sMsgName, NMFieldThis_T::m_struct, _nm_field_def_struct::m_this, _nm_msg_def_struct::m_uCount, NMCtl_T::m_uDepth, NMLIB_TRACE_FIELD, and nmPackFlatStream().

{
  const NMMsgDef_T *pStructDef;   // pointer to structure message definition
  int               n;            // byte count/error code

  pStructDef  = pFieldDef->m_this.m_struct;

  NMLIB_TRACE_FIELD(pFieldDef, buf, 0, pCtl, "structdef %s, member_count=%zu",
      pStructDef->m_sMsgName, pStructDef->m_uCount);

  pCtl->m_uDepth++;

  // copy struct field value
  n = nmPackFlatStream(pStructDef, pVal, buf, bufSize, eEndian, pCtl);

  pCtl->m_uDepth--;

  return n;
}

static int nmPackFlatU16 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack an unsigned 16-bit Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 206 of file nmLibPackFlat.c.

References NM_OK, NMLIB_TRACE_FIELD, nmPackU16(), and nmSetU16().

{
  ushort_t  val;  // constrained field value
  int       n;    // byte count/error code

  // try to set field value
  if( (n = nmSetU16(pFieldDef, pVal, &val)) != NM_OK )
  {
    return n;
  }

  // pack field value
  n = nmPackU16(val, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%hu", val);

  return n;
}

static int nmPackFlatU32 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack an unsigned 32-bit Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 266 of file nmLibPackFlat.c.

References NM_OK, NMLIB_TRACE_FIELD, nmPackU32(), and nmSetU32().

{
  uint_t  val;  // constrained field value
  int     n;    // byte count/error code

  // set field value
  if( (n = nmSetU32(pFieldDef, pVal, &val)) != NM_OK )
  {
    return n;
  }

  // pack field value
  n = nmPackU32(val, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%u", val);

  return n;
}

static int nmPackFlatU64 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack an unsigned 64-bit Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 326 of file nmLibPackFlat.c.

References NM_OK, NMLIB_TRACE_FIELD, nmPackU64(), and nmSetU64().

{
  ulonglong_t val;  // constrained field value
  int         n;    // byte count/error code

  // set field value
  if( (n = nmSetU64(pFieldDef, pVal, &val)) != NM_OK )
  {
    return n;
  }

  // pack field value
  n = nmPackU64(val, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%llu", val);

  return n;
}

static int nmPackFlatU8 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack an unsigned 8-bit Flat field into the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 146 of file nmLibPackFlat.c.

References NM_OK, NMLIB_TRACE_FIELD, nmPackU8(), and nmSetU8().

{
  byte_t  val;    // constrained field value
  int     n;      // byte count/error code

  // try to set field value
  if( (n = nmSetU8(pFieldDef, pVal, &val)) != NM_OK )
  {
    return n;
  }

  // pack field value
  n = nmPackU8(val, buf, bufSize, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%hhu", val);

  return n;
}

static int nmPackFlatVector ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack variable length vector Flat field into the message buffer.

A vector is a one-dimension array of the given type.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pVal	Pointer to (typecasted) value to pack.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	eEndian	Packing order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes packed. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 587 of file nmLibPackFlat.c.

References NMCtl_T::m_bNoHdr, NMVec_T::m_buf, _nm_field_def_struct::m_eFType, NMFieldThisVector_T::m_pThisElem, _nm_field_def_struct::m_this, NMVec_T::m_uCount, NMCtl_T::m_uDepth, NMFieldThisVector_T::m_uElemSize, NMFieldThisVector_T::m_uMaxCount, NMFieldThis_T::m_vector, NM_ECODE_FTYPE, NM_ECODE_NOMEM, NM_ECODE_RANGE, NMFTYPE_IS_SIMPLE, NMLIB_ASCII_FTYPE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, and nmLookupFlatPacker().

{
  size_t              uMaxCount;          // vector maximum number of elements
  size_t              uElemSize;          // vector element size
  const NMFieldDef_T *pElemDef;           // vector element field definition
  NMVec_T            *pVec;               // pointer to vector field template
  size_t              uCount;             // number of vector items to pack
  byte_t             *pItem;              // working vector item pointer
  NMPackFunc_T        fnPack;             // vector item packing function
  int                 n;                  // byte count/error code
  int                 k;                  // subbyte count/error code
  size_t              i;                  // working vector index

  uMaxCount = pFieldDef->m_this.m_vector.m_uMaxCount;
  uElemSize = pFieldDef->m_this.m_vector.m_uElemSize;
  pElemDef  = pFieldDef->m_this.m_vector.m_pThisElem;
  pVec      = (NMVec_T *)pVal;                    // generalized vector overlay
  uCount    = pVec->m_uCount;                     // number of vector items
  pItem     = (byte_t *)(pVec) + memberoffset(NMVec_T, u.m_buf);
  fnPack    = nmLookupFlatPacker(pElemDef->m_eFType);

  if( fnPack == NULL )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_FTYPE, pFieldDef,
        "vector_elem_ftype='%c'(0x%02x)",
        NMLIB_ASCII_FTYPE(pElemDef->m_eFType), pElemDef->m_eFType);
  }

  // exceeds maximum
  else if( uCount > uMaxCount )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_RANGE, pFieldDef,
        "vector_count=%zu > vector_max_count=%zu.", uCount, uMaxCount);
  }

  NMLIB_TRACE_FIELD(pFieldDef, buf, 0, pCtl, "%c:vector[%zu], max_count=%zu",
      pElemDef->m_eFType, uCount, uMaxCount);

  // no header for simple vector element types
  if( NMFTYPE_IS_SIMPLE(pElemDef->m_eFType) )
  {
    pCtl->m_bNoHdr = true;
  }

  pCtl->m_uDepth++;

  // copy vector field value
  for(i=0, n=0; i<uCount; ++i)
  {
    k = fnPack(pElemDef, pItem, &buf[n], bufSize-(size_t)n, eEndian, pCtl);

    if( k < 0 )
    {
      return k;
    }

    n += k;

    pItem += uElemSize;
  }

  // pad out fixed size vector with zero's.
  if( uCount < uMaxCount )
  {
    i = (uMaxCount - uCount) * uElemSize;

    if( i > bufSize-(size_t)n)
    {
      NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < vector_pad_size=%zu", bufSize-(size_t)n, i);
    }

    else
    {
      memset(&buf[n], 0, i);
      n += (int)i;
    }
  }

  pCtl->m_uDepth--;
  pCtl->m_bNoHdr = false;

  return n;
}

static int nmUnpackFlatBool ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack an unsigned 8-bit boolean Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 793 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackBool().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackBool(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%s",
        (*((bool_t *)pVal)? "true": "false"));

  return n;
}

static int nmUnpackFlatF32 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack a 32-bit floating-point number Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 1002 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackF32().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackF32(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%f", *((float *)pVal));

  return n;
}

static int nmUnpackFlatF64 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack a 64-bit floating-point number Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 1026 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackF64().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackF64(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%e", *((double *)pVal));

  return n;
}

int nmUnpackFlatMsg	(	const NMMsgDef_T *	pMsgDef,
		byte_t	buf[],
		size_t	uMsgLen,
		void *	pStruct,
		NMEndian_T	eEndian
	)

Unpack a Flat message.

Parameters

	pMsgDef	Pointer to message definition.
[in]	buf	Input message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure to populate.
	eEndian	Unpacking order. See NMEndian_T.

Returns

On success, returns the number of bytes unpacked. On error, returns < 0.

Definition at line 1490 of file nmLibPackFlat.c.

References NMCtl_T::m_bNoHdr, NMCTL_INIT_DECL, and nmUnpackFlatStream().

Referenced by nmUnpackPointer().

{
  NMCtl_T   ctl = NMCTL_INIT_DECL;
  int       n;      // byte count/error code

  ctl.m_bNoHdr  = true;

  // unpack stream
  n = nmUnpackFlatStream(pMsgDef, buf, uMsgLen, pStruct, eEndian, &ctl);

  // return code
  return n;
}

int nmUnpackFlatMsgDebug	(	const NMMsgDef_T *	pMsgDef,
		byte_t	buf[],
		size_t	uMsgLen,
		void *	pStruct,
		NMEndian_T	eEndian
	)

Unpack a Flat message, tracing unpacking to stderr.

Parameters

	pMsgDef	Pointer to message definition.
[in]	buf	Input message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure to populate.
	eEndian	Unpacking order. See NMEndian_T.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 1520 of file nmLibPackFlat.c.

References NMCtl_T::m_bNoHdr, NMCtl_T::m_bTrace, _nm_msg_def_struct::m_eMsgId, _nm_msg_def_struct::m_sMsgName, _nm_msg_def_struct::m_uCount, NMCTL_INIT_DECL, nmPrintBuf(), and nmUnpackFlatStream().

Referenced by nmUnpackPointer().

{
  NMCtl_T   ctl = NMCTL_INIT_DECL;
  int       n;      // byte count/error code

  ctl.m_bNoHdr  = true;
  ctl.m_bTrace  = true;

  // trace
  fprintf(stderr, "\n--- Unpacking Flat Message %s(%u): field_count=%zu\n",
                  pMsgDef->m_sMsgName, pMsgDef->m_eMsgId, pMsgDef->m_uCount);
  fprintf(stderr, "Input Buffer (%zu bytes):\n", uMsgLen);
  nmPrintBuf(stderr, NULL, buf, uMsgLen, 16, 0);
  fprintf(stderr, "\n");

  // unpack stream
  n = nmUnpackFlatStream(pMsgDef, buf, uMsgLen, pStruct, eEndian, &ctl);

  // return code
  return n;
}

static int nmUnpackFlatP32 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack a 32-bit pointer Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 1049 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackP32().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackP32(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%p", *((ulong_t *)pVal));

  return n;
}

static int nmUnpackFlatP64 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack a 64-bit pointer Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 1072 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackP64().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackP64(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%p", *((ulong_t *)pVal));

  return n;
}

static int nmUnpackFlatPad ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack pad byte from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 763 of file nmLibPackFlat.c.

References _nm_field_def_struct::m_eFId, NMFieldThis_T::m_pad, _nm_field_def_struct::m_this, NMFieldThisPad_T::m_uCount, NM_ECODE_NOMEM, NMLIB_RAISE_FIELD_ERROR, and NMLIB_TRACE_FIELD.

{
  size_t    uCount = pFieldDef->m_this.m_pad.m_uCount;

  // unpack pad bytes
  if( uCount <= bufSize )
  {
    NMLIB_TRACE_FIELD(NULL, buf, uCount, pCtl, "pad(%u)", pFieldDef->m_eFId);
    return (int)uCount;
  }

  // no more space in buffer for pad bytes
  else
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < pad_count=%zu", bufSize, uCount);
  }
}

static int nmUnpackFlatS16 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack a signed 16-bit Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 886 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackS16().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackS16(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%hd", *((short *)pVal));

  return n;
}

static int nmUnpackFlatS32 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack a signed 32-bit Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 932 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackS32().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackS32(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%d", *((int *)pVal));

  return n;
}

static int nmUnpackFlatS64 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack a signed 64-bit Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 978 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackS64().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackS64(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%lld", *((long long *)pVal));

  return n;
}

static int nmUnpackFlatS8 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack a signed 8-bit Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 840 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackS8().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackS8(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%hhd", *((signed char *)pVal));

  return n;
}

static int nmUnpackFlatStream ( const NMMsgDef_T *  pMsgDef, byte_t  buf[], size_t  uMsgLen, void *  pStruct, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack an Flat byte stream.

Parameters

	pMsgDef	Pointer to message definition.
[in]	buf	Input message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure to populate.
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Pointer to Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 1239 of file nmLibPackFlat.c.

References _nm_field_def_struct::m_eFType, _nm_msg_def_struct::m_eMsgId, _nm_msg_def_struct::m_pFields, _nm_field_def_struct::m_uOffset, NM_ECODE_FTYPE, NM_ECODE_NOMEM, NMFTypePad, NMLIB_ASCII_FTYPE, NMLIB_RAISE_ERROR, NMLIB_RAISE_FIELD_ERROR, and nmLookupFlatUnpacker().

Referenced by nmUnpackFlatMsg(), nmUnpackFlatMsgDebug(), and nmUnpackFlatStruct().

{
  size_t              uFieldNum;        // field instance number (not id)
  const NMFieldDef_T *pFieldDef;        // working field definition pointer
  NMUnpackFunc_T      fnUnpack;         // field unpack function
  void               *pVal;             // pointer to field value
  int                 n = 0;            // byte count/error code
  int                 k;                // subbyte count/error code

  for(uFieldNum=0, pFieldDef=pMsgDef->m_pFields;
      uFieldNum < pMsgDef->m_uCount;
      ++uFieldNum, ++pFieldDef)
  {
    if( n < uMsgLen )
    {
      if( pFieldDef->m_eFType == NMFTypePad )
      {
        pVal    = NULL;
      }

      else
      {
        pVal    = pStruct + pFieldDef->m_uOffset;
      }

      fnUnpack = nmLookupFlatUnpacker(pFieldDef->m_eFType);

      if( fnUnpack == NULL )
      {
        NMLIB_RAISE_FIELD_ERROR(NM_ECODE_FTYPE, pFieldDef,
               "ftype='%c'(0x%02x).",
                NMLIB_ASCII_FTYPE(pFieldDef->m_eFType), pFieldDef->m_eFType);
      }

      k = fnUnpack(pFieldDef, &buf[n], uMsgLen-(size_t)n, pVal, eEndian, pCtl);

      if( k < 0 )
      {
        return k;
      }
    }

    else
    {
      NMLIB_RAISE_ERROR(NM_ECODE_NOMEM,
        "buf_size=%zu, msgid=%u", uMsgLen, pMsgDef->m_eMsgId);
    }

    n += k;
  }

  return n;
}

static int nmUnpackFlatString ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack variable length string Flat field from the message buffer.

Note

The null character is appended to the end of the unpacked value.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 1097 of file nmLibPackFlat.c.

References NMFieldThis_T::m_string, _nm_field_def_struct::m_this, NMFieldThisString_T::m_uMaxCount, NM_ECODE_NOMEM, NMLIB_RAISE_FIELD_ERROR, and NMLIB_TRACE_FIELD.

{
  size_t    uMaxCount;    // maximum string length
  char     *sVal;         // string pointer

  // field definition and derived values
  uMaxCount   = pFieldDef->m_this.m_string.m_uMaxCount;
  sVal        = (char *)pVal;

  if( uMaxCount > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu, max_count=%zu", bufSize, uMaxCount);
  }

  memcpy(sVal, buf, uMaxCount);
  sVal[uMaxCount] = 0;

  NMLIB_TRACE_FIELD(pFieldDef, buf, uMaxCount, pCtl, "'%s'", sVal);

  return (int)uMaxCount;
}

static int nmUnpackFlatStruct ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack structure Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 1132 of file nmLibPackFlat.c.

References _nm_msg_def_struct::m_sMsgName, NMFieldThis_T::m_struct, _nm_field_def_struct::m_this, _nm_msg_def_struct::m_uCount, NMCtl_T::m_uDepth, NMLIB_TRACE_FIELD, and nmUnpackFlatStream().

{
  const NMMsgDef_T *pStructDef;   // structure definition
  int               n;            // byte count/error code

  pStructDef  = pFieldDef->m_this.m_struct;

  NMLIB_TRACE_FIELD(pFieldDef, buf, 0, pCtl, "structdef %s, member_count=%zu",
      pStructDef->m_sMsgName, pStructDef->m_uCount);

  pCtl->m_uDepth++;

  // copy struct field value
  n = nmUnpackFlatStream(pStructDef, buf, bufSize, pVal, eEndian, pCtl);

  pCtl->m_uDepth--;

  return n;
}

static int nmUnpackFlatU16 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack an unsigned 16-bit Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 863 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackU16().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackU16(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%hu", *((ushort_t *)pVal));

 return n;
}

static int nmUnpackFlatU32 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack an unsigned 32-bit Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 909 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackU32().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackU32(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%u", *((uint_t *)pVal));

  return n;
}

static int nmUnpackFlatU64 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack an unsigned 64-bit Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 955 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackU64().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackU64(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%llu", *((ulonglong_t *)pVal));

  return n;
}

static int nmUnpackFlatU8 ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack an unsigned 8-bit Flat field from the message buffer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 817 of file nmLibPackFlat.c.

References NMLIB_TRACE_FIELD, and nmUnpackU8().

{
  int       n;    // byte count/error code

  // unpack value
  n = nmUnpackU8(buf, bufSize, pVal, eEndian);

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "%hhu", *((byte_t *)pVal));

  return n;
}

static int nmUnpackFlatVector ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, void *  pVal, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Unpack variable length vector Flat field from the message buffer.

A vector is a one-dimension array of the given type.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pVal	Pointer to value to unpack (set).
	eEndian	Unpacking order. See NMEndian_T.
	pCtl	Internal control.

Returns

On success, returns the number of bytes unpacked. On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 1165 of file nmLibPackFlat.c.

References NMVec_T::m_buf, _nm_field_def_struct::m_eFType, NMFieldThisVector_T::m_pThisElem, _nm_field_def_struct::m_this, NMCtl_T::m_uDepth, NMFieldThisVector_T::m_uElemSize, NMFieldThisVector_T::m_uMaxCount, NMFieldThis_T::m_vector, NM_ECODE_FTYPE, NMLIB_ASCII_FTYPE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, and nmLookupFlatUnpacker().

{
  size_t              uMaxCount;          // vector maximum number of elements
  size_t              uElemSize;          // vector element size
  const NMFieldDef_T *pElemDef;           // vector element field definition
  NMVec_T            *pVec;               // pointer to vector field template
  byte_t             *pItem;              // working vector item pointer
  NMFType_T           eVType;             // vector itim field type
  NMUnpackFunc_T      fnUnpack;           // vector item unpacking function
  int                 n;                  // byte count/error code
  int                 k;                  // subbyte count/error code
  size_t              i;                  // working vector index

  // field definition and derived values
  uMaxCount = pFieldDef->m_this.m_vector.m_uMaxCount;
  uElemSize = pFieldDef->m_this.m_vector.m_uElemSize;
  pElemDef  = pFieldDef->m_this.m_vector.m_pThisElem;
  pVec      = (NMVec_T *)pVal;                    // generalized vector overlay
  pItem     = (byte_t *)(pVec) + memberoffset(NMVec_T, u.m_buf);
  eVType    = pElemDef->m_eFType;
  fnUnpack  = nmLookupFlatUnpacker(eVType);

  // no unpacker
  if( fnUnpack == NULL )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_FTYPE, pFieldDef,
        "vector_elem_ftype='%c'(0x%02x).",
        NMLIB_ASCII_FTYPE(pElemDef->m_eFType), eVType);
  }

  NMLIB_TRACE_FIELD(pFieldDef, buf, 0, pCtl,
        "vector_max_count=%zu, vector_elem_ftype='%c'(0x%02x)",
         uMaxCount, NMLIB_ASCII_FTYPE(eVType), eVType);

  pCtl->m_uDepth++;

  // unpack field into vector field
  for(i=0, n=0; i<uMaxCount; ++i)
  {
    k = fnUnpack(pElemDef, &buf[n], bufSize-(size_t)n, pItem, eEndian, pCtl);

    if( k < 0 )
    {
      return k;
    }

    n += k;

    pItem += uElemSize;
  }

  pCtl->m_uDepth--;

  return n;
}

Variable Documentation

NMLookupTblEntry_T NMFlatLookupTbl[]

static

Initial value:

=
{
  {NMFTypeBool,       nmPackFlatBool,     nmUnpackFlatBool},      
  {NMFTypeU8,         nmPackFlatU8,       nmUnpackFlatU8},        
  {NMFTypeF64,        nmPackFlatF64,      nmUnpackFlatF64},       
  {NMFTypeU16,        nmPackFlatU16,      nmUnpackFlatU16},       
  {NMFTypeU32,        nmPackFlatU32,      nmUnpackFlatU32},       
  {NMFTypeP64,        nmPackFlatP64,      nmUnpackFlatP64},       
  {NMFTypeU64,        nmPackFlatU64,      nmUnpackFlatU64},       
  {NMFTypeVector,     nmPackFlatVector,   nmUnpackFlatVector},    
  {NMFTypeS8,         nmPackFlatS8,       nmUnpackFlatS8},        
  {NMFTypeChar,       nmPackFlatU8,       nmUnpackFlatU8},        
  {NMFTypeF32,        nmPackFlatF32,      nmUnpackFlatF32},       
  {NMFTypeS16,        nmPackFlatS16,      nmUnpackFlatS16},       
  {NMFTypeS32,        nmPackFlatS32,      nmUnpackFlatS32},       
  {NMFTypeP32,        nmPackFlatP32,      nmUnpackFlatP32},       
  {NMFTypeS64,        nmPackFlatS64,      nmUnpackFlatS64},       
  {NMFTypeString,     nmPackFlatString,   nmUnpackFlatString},    
  {NMFTypePad,        nmPackFlatPad,      nmUnpackFlatPad},       
  {NMFTypeStruct,     nmPackFlatStruct,   nmUnpackFlatStruct}     
}

Flat Info Lookup Table

Warning

Keep in asending order by ftype.

Definition at line 1308 of file nmLibPackFlat.c.