nmLibPackITV.c File Reference

Identifier-Type-Value (ITV) 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.

Macros
#define	ITVPACK_SIMPLE_HDR(p, buf, n, ctl)   ((ctl)->m_bNoHdr? 0: nmPackITVHdrSimple(p, buf, n))
	Pack simple field type ITV header. More...

Functions
static NMPackFunc_T	nmLookupITVPacker (NMFType_T eFType)
	Lookup ITV packer function, given the message field type. More...
static NMUnpackFunc_T	nmLookupITVUnpacker (NMFType_T eFType)
	Lookup ITV unpacker function, given the message field type. More...
static int	nmPackITVStream (const NMMsgDef_T *pMsgDef, void *pStruct, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a ITV message. More...
static int	nmUnpackITVStream (const NMMsgDef_T *pMsgDef, byte_t buf[], size_t uMsgLen, size_t uCount, void *pStruct, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an ITV byte stream. More...
static int	nmPackITVHdrSimple (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize)
	Pack ITV simple header. More...
static int	nmPackITVHdrString (const NMFieldDef_T *pFieldDef, size_t uCount, byte_t buf[], size_t bufSize)
	Pack ITV String header. More...
static int	nmPackITVHdrStruct (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize)
	Pack ITV Struct header. More...
static int	nmPackITVHdrVector (const NMFieldDef_T *pFieldDef, size_t uCount, byte_t buf[], size_t bufSize)
	Pack ITV Vector header. More...
static int	nmPackITVPad (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	nmPackITVBool (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 ITV field into the message buffer. More...
static int	nmPackITVU8 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack an unsigned 8-bit ITV field into the message buffer. More...
static int	nmPackITVS8 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a signed 8-bit ITV field into the message buffer. More...
static int	nmPackITVU16 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack an unsigned 16-bit ITV field into the message buffer. More...
static int	nmPackITVS16 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a signed 16-bit ITV field into the message buffer. More...
static int	nmPackITVU32 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack an unsigned 32-bit ITV field into the message buffer. More...
static int	nmPackITVS32 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a signed 32-bit ITV field into the message buffer. More...
static int	nmPackITVU64 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack an unsigned 64-bit ITV field into the message buffer. More...
static int	nmPackITVS64 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a signed 64-bit ITV field into the message buffer. More...
static int	nmPackITVF32 (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 ITV field into the message buffer. More...
static int	nmPackITVF64 (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 ITV field into the message buffer. More...
static int	nmPackITVP32 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a 32-bit pointer ITV field into the message buffer. More...
static int	nmPackITVP64 (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a 64-bit pointer ITV field into the message buffer. More...
static int	nmPackITVString (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack null-terminated, variable length string ITV field into the message buffer. More...
static int	nmPackITVStruct (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack a structure ITV field into the message buffer. More...
static int	nmPackITVVector (const NMFieldDef_T *pFieldDef, void *pVal, byte_t buf[], size_t bufSize, NMEndian_T eEndian, NMCtl_T *pCtl)
	Pack variable length vector ITV field into the message buffer. More...
static int	nmUnpackITVNoExec (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, size_t uFLen, NMCtl_T *pCtl)
	Move parse cursor position past current field in message stream field. More...
static int	nmUnpackITVPad (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	nmUnpackITVBool (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an unsigned 8-bit boolean ITV field from the message buffer. More...
static int	nmUnpackITVU8 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an unsigned 8-bit ITV field from the message buffer. More...
static int	nmUnpackITVS8 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a signed 8-bit ITV field from the message buffer. More...
static int	nmUnpackITVU16 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an unsigned 16-bit ITV field from the message buffer. More...
static int	nmUnpackITVS16 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a signed 16-bit ITV field from the message buffer. More...
static int	nmUnpackITVU32 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an unsigned 32-bit ITV field from the message buffer. More...
static int	nmUnpackITVS32 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a signed 32-bit ITV field from the message buffer. More...
static int	nmUnpackITVU64 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack an unsigned 64-bit ITV field from the message buffer. More...
static int	nmUnpackITVS64 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a signed 64-bit ITV field from the message buffer. More...
static int	nmUnpackITVF32 (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 ITV field from the message buffer. More...
static int	nmUnpackITVF64 (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 ITV field from the message buffer. More...
static int	nmUnpackITVP32 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a 32-bit pointer ITV field from the message buffer. More...
static int	nmUnpackITVP64 (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack a 64-bit pointer ITV field from the message buffer. More...
static int	nmUnpackITVString (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack variable length string ITV field from the message buffer. More...
static int	nmUnpackITVStruct (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack structure ITV field from the message buffer. More...
static int	nmUnpackITVVector (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t bufSize, void *pVal, NMEndian_T eEndian, NMCtl_T *pCtl)
	Unpack variable length vector ITV field from the message buffer. More...
int	nmPackITVMsg (const NMMsgDef_T *pMsgDef, void *pStruct, byte_t buf[], size_t bufSize, NMEndian_T eEndian)
	Pack an ITV message. More...
int	nmPackITVMsgDebug (const NMMsgDef_T *pMsgDef, void *pStruct, byte_t buf[], size_t bufSize, NMEndian_T eEndian)
	Pack an ITV message, tracing message packing to stderr. More...
int	nmUnpackITVMsg (const NMMsgDef_T *pMsgDef, byte_t buf[], size_t uMsgLen, void *pStruct, NMEndian_T eEndian)
	Unpack a ITV message. More...
int	nmUnpackITVMsgDebug (const NMMsgDef_T *pMsgDef, byte_t buf[], size_t uMsgLen, void *pStruct, NMEndian_T eEndian)
	Unpack a ITV message, tracing unpacking to stderr. More...
uint_t	nmGetITVMsgId (byte_t buf[], size_t uMsgLen, NMEndian_T eEndian)
	Get ITV message id from input buffer. More...

Variables
static NMLookupTblEntry_T	NMITVLookupTbl []

Detailed Description

Identifier-Type-Value (ITV) message packing/unpacking definitions.

LastChangedDate

2010-07-31 08:48:56 -0600 (Sat, 31 Jul 2010)

Rev

521

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 nmLibPackITV.c.

Macro Definition Documentation

#define ITVPACK_SIMPLE_HDR	(		p,
			buf,
			n,
			ctl
	)		((ctl)->m_bNoHdr? 0: nmPackITVHdrSimple(p, buf, n))

Pack simple field type ITV header.

Parameters

	p	Pointer to message field definition.
[out]	buf	Output message buffer.
	n	Size of output buffer.
	ctl	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 93 of file nmLibPackITV.c.

Referenced by nmPackITVBool(), nmPackITVF32(), nmPackITVF64(), nmPackITVP32(), nmPackITVP64(), nmPackITVS16(), nmPackITVS32(), nmPackITVS64(), nmPackITVS8(), nmPackITVU16(), nmPackITVU32(), nmPackITVU64(), and nmPackITVU8().

Function Documentation

uint_t nmGetITVMsgId	(	byte_t	buf[],
		size_t	uMsgLen,
		NMEndian_T	eEndian
	)

Get ITV message id from input buffer.

Parameters

[in]	buf	Input message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
	eEndian	Unpacking order. See NMEndian_T.

Returns

On success, returns unpacked message id.
On error, returns NMMSG_ID_NONE (0).

Definition at line 2482 of file nmLibPackITV.c.

References NMITV_MSGHDR_SIZE, NMMSG_ID_NONE, and nmUnpackU16().

Referenced by nmUnpackPointer().

{
  ushort_t  eMsgId; // message id in buffer
  int       n;

  // too small
  if( uMsgLen < NMITV_MSGHDR_SIZE )
  {
    return (uint_t)NMMSG_ID_NONE;
  }
  
  // unpack message id
  else if( (n = nmUnpackU16(buf, uMsgLen, &eMsgId, eEndian)) < 0 )
  {
    return (uint_t)NMMSG_ID_NONE;
  }

  else
  {
    return (uint_t)eMsgId;
  }
}

static NMPackFunc_T nmLookupITVPacker ( NMFType_T  eFType )

static

Lookup ITV packer function, given the message field type.

Parameters

eFType

Message field type.

Returns

Returns packer function on success, NULL on failure.

Definition at line 2174 of file nmLibPackITV.c.

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

Referenced by nmPackITVStream(), and nmPackITVVector().

{
  int idx;
 
  idx = NMHashFType(eFType);

  if( (idx != NMHashNoIdx) && (idx < arraysize(NMITVLookupTbl)) )
  {
    if( NMITVLookupTbl[idx].m_eFType == eFType )
    {
      return NMITVLookupTbl[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(NMITVLookupTbl[idx].m_eFType),
        NMITVLookupTbl[idx].m_eFType);
      return NULL;
    }
  }
  else
  {
    return NULL;
  }
}

static NMUnpackFunc_T nmLookupITVUnpacker ( NMFType_T  eFType )

static

Lookup ITV unpacker function, given the message field type.

Parameters

eFType

Message field type.

Returns

Returns unpacker function on success, NULL on failure.

Definition at line 2209 of file nmLibPackITV.c.

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

Referenced by nmUnpackITVStream(), and nmUnpackITVVector().

{
  int idx;
 
  idx = NMHashFType(eFType);

  if( (idx != NMHashNoIdx) && (idx < arraysize(NMITVLookupTbl)) )
  {
    if( NMITVLookupTbl[idx].m_eFType == eFType )
    {
      return NMITVLookupTbl[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(NMITVLookupTbl[idx].m_eFType),
        NMITVLookupTbl[idx].m_eFType);
      return NULL;
    }
  }
  else
  {
    return NULL;
  }
}

static int nmPackITVBool ( 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 ITV 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 257 of file nmLibPackITV.c.

References ITVPACK_SIMPLE_HDR, NMLIB_TRACE_FIELD, and nmPackBool().

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

  val = *((bool_t *)pVal);

  // try to pack header
  if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackBool(val, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

static int nmPackITVF32 ( 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 ITV 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 667 of file nmLibPackITV.c.

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

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

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

  // try to pack header
  else if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackF32(val, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

static int nmPackITVF64 ( 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 ITV 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 713 of file nmLibPackITV.c.

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

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

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

  // try to pack header
  else if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackF64(val, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

static int nmPackITVHdrSimple ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize  )

static

Pack ITV simple header.

Parameters

	pFieldDef	Pointer to message field definition.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.

Returns

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

Definition at line 105 of file nmLibPackITV.c.

References _nm_field_def_struct::m_eFId, _nm_field_def_struct::m_eFType, NM_ECODE_NOMEM, NMITV_FHDR_SIZE_SIMPLE, NMITV_FHDR_SIZE_STRING, and NMLIB_RAISE_FIELD_ERROR.

{
  // pack simple ITV header
  if( NMITV_FHDR_SIZE_SIMPLE <= bufSize )
  {
    buf[0] = (byte_t)(pFieldDef->m_eFId & 0xff);
    buf[1] = (byte_t)(pFieldDef->m_eFType & 0xff);
    return NMITV_FHDR_SIZE_SIMPLE;
  }

  // no more space in buffer for header
  else
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, NMITV_FHDR_SIZE_STRING);
  }
}

static int nmPackITVHdrString ( const NMFieldDef_T *  pFieldDef, size_t  uCount, byte_t  buf[], size_t  bufSize  )

static

Pack ITV String header.

Parameters

	pFieldDef	Pointer to message field definition.
	uCount	Number of character bytes in string.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.

Returns

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

Definition at line 135 of file nmLibPackITV.c.

References _nm_field_def_struct::m_eFId, _nm_field_def_struct::m_eFType, NM_ECODE_NOMEM, NMITV_FHDR_SIZE_STRING, and NMLIB_RAISE_FIELD_ERROR.

Referenced by nmPackITVString().

{
  // pack string ITV header
  if( NMITV_FHDR_SIZE_STRING <= bufSize )
  {
    buf[0] = (byte_t)(pFieldDef->m_eFId & 0xff);
    buf[1] = (byte_t)(pFieldDef->m_eFType & 0xff);
    buf[2] = (byte_t)(uCount & 0xff);
    return NMITV_FHDR_SIZE_STRING;
  }

  // no more space in buffer for header
  else
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, NMITV_FHDR_SIZE_STRING);
  }
}

static int nmPackITVHdrStruct ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize  )

static

Pack ITV Struct header.

Parameters

	pFieldDef	Pointer to message field definition.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.

Returns

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

Definition at line 166 of file nmLibPackITV.c.

References _nm_field_def_struct::m_eFId, _nm_field_def_struct::m_eFType, NMFieldThis_T::m_struct, _nm_field_def_struct::m_this, _nm_msg_def_struct::m_uCount, NM_ECODE_NOMEM, NMITV_FHDR_SIZE_STRUCT, and NMLIB_RAISE_FIELD_ERROR.

Referenced by nmPackITVStruct().

{
  // pack struct ITV header
  if( NMITV_FHDR_SIZE_STRUCT <= bufSize )
  {
    buf[0] = (byte_t)(pFieldDef->m_eFId & 0xff);
    buf[1] = (byte_t)(pFieldDef->m_eFType & 0xff);
    buf[2] = (byte_t)pFieldDef->m_this.m_struct->m_uCount;
    return NMITV_FHDR_SIZE_STRUCT;
  }

  // no more space in buffer for header
  else
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%zu", bufSize, NMITV_FHDR_SIZE_STRUCT);
  }
}

static int nmPackITVHdrVector ( const NMFieldDef_T *  pFieldDef, size_t  uCount, byte_t  buf[], size_t  bufSize  )

static

Pack ITV Vector header.

Parameters

	pFieldDef	Pointer to message field definition.
	uCount	Number of vector elements.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.

Returns

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

Definition at line 197 of file nmLibPackITV.c.

References _nm_field_def_struct::m_eFId, _nm_field_def_struct::m_eFType, NMFieldThisVector_T::m_pThisElem, _nm_field_def_struct::m_this, NMFieldThis_T::m_vector, NM_ECODE_NOMEM, NMITV_FHDR_SIZE_VECTOR, and NMLIB_RAISE_FIELD_ERROR.

Referenced by nmPackITVVector().

{
  // pack vector ITV header
  if( NMITV_FHDR_SIZE_VECTOR <= bufSize )
  {
    buf[0] = (byte_t)(pFieldDef->m_eFId & 0xff);
    buf[1] = (byte_t)(pFieldDef->m_eFType & 0xff);
    buf[2] = (byte_t)(uCount & 0xff);
    buf[3] = (byte_t)pFieldDef->m_this.m_vector.m_pThisElem->m_eFType;
    return NMITV_FHDR_SIZE_VECTOR;
  }

  // no more space in buffer for header
  else
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, NMITV_FHDR_SIZE_VECTOR);
  }
}

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

Pack an ITV 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 2254 of file nmLibPackITV.c.

References _nm_msg_def_struct::m_eMsgId, _nm_msg_def_struct::m_sMsgName, _nm_msg_def_struct::m_uCount, NM_ECODE_NOMEM, NMCTL_INIT_DECL, NMITV_MSGHDR_SIZE, NMLIB_RAISE_ERROR, nmPackITVStream(), and nmPackU16().

Referenced by nmUnpackPointer().

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

  // too small
  if( bufSize < NMITV_MSGHDR_SIZE )
  {
    NMLIB_RAISE_ERROR(NM_ECODE_NOMEM, "%s(%u): msg_len=%u, hdr_size=%u",
            pMsgDef->m_sMsgName, pMsgDef->m_eMsgId, bufSize, NMITV_MSGHDR_SIZE);
  }

  // pack message id
  if( (n = nmPackU16((ushort)(pMsgDef->m_eMsgId), buf, bufSize, eEndian)) < 0 )
  {
    return n;
  }

  // pack field count
  buf[n++] = (byte_t)pMsgDef->m_uCount;

  // pack stream
  k = nmPackITVStream(pMsgDef, pStruct, &buf[n], bufSize-(size_t)n, eEndian,
                                &ctl);

  return k >= 0? n+k: k;
}

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

Pack an ITV 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 2299 of file nmLibPackITV.c.

References NMCtl_T::m_bTrace, _nm_msg_def_struct::m_eMsgId, _nm_msg_def_struct::m_sMsgName, _nm_msg_def_struct::m_uCount, NM_ECODE_NOMEM, NMCTL_INIT_DECL, NMITV_MSGHDR_SIZE, NMLIB_RAISE_ERROR, nmPackITVStream(), nmPackU16(), and nmPrintBuf().

Referenced by nmUnpackPointer().

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

  ctl.m_bTrace  = true;

  // too small
  if( bufSize < NMITV_MSGHDR_SIZE )
  {
    NMLIB_RAISE_ERROR(NM_ECODE_NOMEM, "%s(%u): msg_len=%u, hdr_size=%u",
            pMsgDef->m_sMsgName, pMsgDef->m_eMsgId, bufSize, NMITV_MSGHDR_SIZE);
  }

  // pack message id
  if( (n = nmPackU16((ushort)(pMsgDef->m_eMsgId), buf, bufSize, eEndian)) < 0 )
  {
    return n;
  }

  // pack field count
  buf[n++] = (byte_t)pMsgDef->m_uCount;

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

  // pack stream
  k = nmPackITVStream(pMsgDef, pStruct, &buf[n], bufSize-(size_t)n, eEndian,
                                &ctl);

  if( k < 0 )
  {
    return k;
  }

  n += k;

  // trace final buffer
  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 nmPackITVP32 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a 32-bit pointer ITV 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 759 of file nmLibPackITV.c.

References ITVPACK_SIMPLE_HDR, NMLIB_TRACE_FIELD, and nmPackP32().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // try to pack header
  if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackP32(pVal, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Pack a 64-bit pointer ITV 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 798 of file nmLibPackITV.c.

References ITVPACK_SIMPLE_HDR, NMLIB_TRACE_FIELD, and nmPackP64().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // try to pack header
  if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackP64(pVal, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

static int nmPackITVPad ( 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 226 of file nmLibPackITV.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 nmPackITVS16 ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack a signed 16-bit ITV 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 437 of file nmLibPackITV.c.

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

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

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

  // try to pack header
  else if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackS16(val, &buf[n], bufSize-(size_t)n, eEndian)) < 0)
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Pack a signed 32-bit ITV 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 529 of file nmLibPackITV.c.

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

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

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

  // try to pack header
  else if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackS32(val, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Pack a signed 64-bit ITV 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 621 of file nmLibPackITV.c.

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

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

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

  // try to pack header
  else if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackS64(val, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Pack a signed 8-bit ITV 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 345 of file nmLibPackITV.c.

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

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

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

  // try to pack header
  else if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackS8(val, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Pack a ITV 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 1035 of file nmLibPackITV.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 nmLookupITVPacker().

Referenced by nmPackITVMsg(), nmPackITVMsgDebug(), and nmPackITVStruct().

{
  size_t              uFieldNum;
  const NMFieldDef_T *pFieldDef;
  NMPackFunc_T        fnPack = NULL;
  void               *pVal;
  int                 n = 0;
  int                 k;

  //
  // 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 = nmLookupITVPacker(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 nmPackITVString ( const NMFieldDef_T *  pFieldDef, void *  pVal, byte_t  buf[], size_t  bufSize, NMEndian_T  eEndian, NMCtl_T *  pCtl  )

static

Pack null-terminated, variable length string ITV 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 840 of file nmLibPackITV.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, NMLIB_TRACE_FIELD, and nmPackITVHdrString().

{
  const char   *sVal;
  const char   *sConst;
  size_t        uMaxCount;
  size_t        uCount;
  int           n = 0;

  sVal      = (const char *)pVal;     // override value pointer type
  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);
  }

  // try to pack ITV header
  if( (n = nmPackITVHdrString(pFieldDef, uCount, buf, bufSize)) < 0 )
  {
    return n;
  }

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

  // copy string field value
  else
  {
    memcpy(&buf[n], sVal, uCount);

    n += (int)uCount;

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

    return n;
  }
}

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

static

Pack a structure ITV 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 903 of file nmLibPackITV.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, nmPackITVHdrStruct(), and nmPackITVStream().

{
  const NMMsgDef_T *pStructDef;
  int               n = 0;
  int               k;

  pStructDef  = pFieldDef->m_this.m_struct;

  // try to pack ITV header
  if( (n = nmPackITVHdrStruct(pFieldDef, buf, bufSize)) < 0 )
  {
    return n;
  }

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

  pCtl->m_uDepth++;

  // copy struct field value
  k = nmPackITVStream(pStructDef, pVal, &buf[n], bufSize-(size_t)n, eEndian,
                        pCtl);

  pCtl->m_uDepth--;

  return k>=0? n+k: k;
}

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

static

Pack an unsigned 16-bit ITV 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 391 of file nmLibPackITV.c.

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

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

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

  // try to pack header
  else if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackU16(val, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Pack an unsigned 32-bit ITV 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 483 of file nmLibPackITV.c.

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

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

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

  // try to pack header
  else if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackU32(val, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Pack an unsigned 64-bit ITV 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 575 of file nmLibPackITV.c.

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

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

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

  // try to pack header
  else if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackU64(val, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Pack an unsigned 8-bit ITV 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 299 of file nmLibPackITV.c.

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

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

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

  // try to pack header
  else if( (n = ITVPACK_SIMPLE_HDR(pFieldDef, buf, bufSize, pCtl)) < 0 )
  {
    return n;
  }

  // try to pack field value
  else if( (k = nmPackU8(val, &buf[n], bufSize-(size_t)n, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Pack variable length vector ITV 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 944 of file nmLibPackITV.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_RANGE, NMFTYPE_IS_SIMPLE, NMLIB_ASCII_FTYPE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmLookupITVPacker(), and nmPackITVHdrVector().

{
  size_t              uMaxCount;
  size_t              uElemSize;
  const NMFieldDef_T *pElemDef;
  NMVec_T            *pVec;
  size_t              uCount;
  byte_t             *pItem;
  NMPackFunc_T        fnPack = NULL;
  int                 n = 0;
  int                 k;
  size_t              i;

  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    = nmLookupITVPacker(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 > max_count=%zu.", uCount, uMaxCount);
  }

  // try to pack ITV header
  else if( (n = nmPackITVHdrVector(pFieldDef, uCount, buf, bufSize)) < 0 )
  {
    return n;
  }

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

  // 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; i<uCount; ++i)
  {
    k = fnPack(pElemDef, pItem, &buf[n], bufSize-(size_t)n, eEndian, pCtl);

    if( k < 0 )
    {
      return k;
    }

    n += k;

    pItem += uElemSize;
  }

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

  return n;
}

static int nmUnpackITVBool ( 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 ITV 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 1164 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_U8, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackBool(), and nmUnpackITVNoExec().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_U8,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackBool(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

static int nmUnpackITVF32 ( 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 ITV 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 1618 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_F32, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackF32(), and nmUnpackITVNoExec().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_F32,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackF32(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

static int nmUnpackITVF64 ( 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 ITV 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 1669 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_F64, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackF64(), and nmUnpackITVNoExec().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_F64,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackF64(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

Unpack a ITV 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 2364 of file nmLibPackITV.c.

References _nm_msg_def_struct::m_eMsgId, _nm_msg_def_struct::m_sMsgName, NM_ECODE_MSGID, NM_ECODE_NOMEM, NMCTL_INIT_DECL, NMITV_MSGHDR_SIZE, NMLIB_RAISE_ERROR, nmUnpackITVStream(), and nmUnpackU16().

Referenced by nmUnpackPointer().

{
  NMCtl_T   ctl = NMCTL_INIT_DECL;
  ushort_t  eMsgId; // message id in buffer
  size_t    uCount; // field count in buffer
  int       n;      // byte count/error code
  int       k;      // subbyte count/error code

  // too small
  if( uMsgLen < NMITV_MSGHDR_SIZE )
  {
    NMLIB_RAISE_ERROR(NM_ECODE_NOMEM, "%s(%u): msg_len=%u, hdr_size=%u",
            pMsgDef->m_sMsgName, pMsgDef->m_eMsgId, uMsgLen, NMITV_MSGHDR_SIZE);
  }

  // unpack message id
  if( (n = nmUnpackU16(buf, uMsgLen, &eMsgId, eEndian)) < 0 )
  {
    return n;
  }

  // field count
  uCount = (size_t)buf[n++];

  // mismatch error
  if( (uint_t)(pMsgDef->m_eMsgId) != (uint_t)eMsgId )
  {
    NMLIB_RAISE_ERROR(NM_ECODE_MSGID, "%s(%u): rcv'd msgid=%u != msgdef's",
            pMsgDef->m_sMsgName, pMsgDef->m_eMsgId, eMsgId);
  }

  // unpack stream
  k = nmUnpackITVStream(pMsgDef, &buf[n], uMsgLen-(size_t)n, uCount,
                            pStruct, eEndian, &ctl);

  // return code
  return k>=0? n+k: k;
}

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

Unpack a ITV 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 2419 of file nmLibPackITV.c.

References NMCtl_T::m_bTrace, _nm_msg_def_struct::m_eMsgId, _nm_msg_def_struct::m_sMsgName, NM_ECODE_MSGID, NM_ECODE_NOMEM, NMCTL_INIT_DECL, NMITV_MSGHDR_SIZE, NMLIB_RAISE_ERROR, nmPrintBuf(), nmUnpackITVStream(), and nmUnpackU16().

Referenced by nmUnpackPointer().

{
  NMCtl_T   ctl = NMCTL_INIT_DECL;
  ushort_t  eMsgId; // message id in buffer
  size_t    uCount; // field count in buffer
  int       n;      // byte count/error code
  int       k;      // subbyte count/error code

  ctl.m_bTrace  = true;

  // too small
  if( uMsgLen < NMITV_MSGHDR_SIZE )
  {
    NMLIB_RAISE_ERROR(NM_ECODE_NOMEM, "%s(%u): msg_len=%u, hdr_size=%u",
            pMsgDef->m_sMsgName, pMsgDef->m_eMsgId, uMsgLen, NMITV_MSGHDR_SIZE);
  }

  // unpack message id
  if( (n = nmUnpackU16(buf, uMsgLen, &eMsgId, eEndian)) < 0 )
  {
    return n;
  }

  // field count
  uCount = (size_t)buf[n++];

  // mismatch error
  if( (uint_t)(pMsgDef->m_eMsgId) != (uint_t)eMsgId )
  {
    NMLIB_RAISE_ERROR(NM_ECODE_MSGID, "%s(%u): rcv'd msgid=%u != msgdef's",
            pMsgDef->m_sMsgName, pMsgDef->m_eMsgId, eMsgId);
  }

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

  // unpack stream
  k = nmUnpackITVStream(pMsgDef, &buf[n], uMsgLen-(size_t)n, uCount,
                            pStruct, eEndian, &ctl);

  // return code
  return k>=0? n+k: k;
}

static int nmUnpackITVNoExec ( const NMFieldDef_T *  pFieldDef, byte_t  buf[], size_t  bufSize, size_t  uFLen, NMCtl_T *  pCtl  )

static

Move parse cursor position past current field in message stream field.

No unpacking field into an output variable is executed.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
	uFLen	Length of field (bytes).
	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 1115 of file nmLibPackITV.c.

References NM_ECODE_NOMEM, NMLIB_RAISE_FIELD_ERROR, and NMLIB_TRACE_FIELD.

Referenced by nmUnpackITVBool(), nmUnpackITVF32(), nmUnpackITVF64(), nmUnpackITVP32(), nmUnpackITVP64(), nmUnpackITVS16(), nmUnpackITVS32(), nmUnpackITVS64(), nmUnpackITVS8(), nmUnpackITVU16(), nmUnpackITVU32(), nmUnpackITVU64(), and nmUnpackITVU8().

{
  if( uFLen > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < flen=%zu", bufSize, uFLen);
  }

  NMLIB_TRACE_FIELD(pFieldDef, buf, uFLen, pCtl, "ignore");

  return (int)uFLen;
}

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

static

Unpack a 32-bit pointer ITV 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 1719 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_P32, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackITVNoExec(), and nmUnpackP32().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_P32,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackP32(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Unpack a 64-bit pointer ITV 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 1769 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_P64, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackITVNoExec(), and nmUnpackP64().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_P64,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackP64(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

static int nmUnpackITVPad ( 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 1138 of file nmLibPackITV.c.

References NMFVAL_PAD, and NMLIB_TRACE_FIELD.

{
  int   n = 0;

  // skip over all pad bytes
  while( (buf[n] == NMFVAL_PAD) && (n < bufSize) )
  {
    ++n;
  }

  NMLIB_TRACE_FIELD(NULL, buf, n, pCtl, "pad");

  return n;
}

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

static

Unpack a signed 16-bit ITV 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 1366 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_S16, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackITVNoExec(), and nmUnpackS16().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_S16,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackS16(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Unpack a signed 32-bit ITV 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 1466 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_S32, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackITVNoExec(), and nmUnpackS32().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_S32,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackS32(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Unpack a signed 64-bit ITV 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 1567 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_S64, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackITVNoExec(), and nmUnpackS64().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_S64,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackS64(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Unpack a signed 8-bit ITV 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 1265 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_S8, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackITVNoExec(), and nmUnpackS8().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_S8,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackS8(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Unpack an ITV 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.
	uCount	Received message/struct field count
	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 2043 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, _nm_field_def_struct::m_eFType, _nm_msg_def_struct::m_eMsgId, _nm_msg_def_struct::m_sMsgName, _nm_field_def_struct::m_uOffset, NM_ECODE_EMSG, NM_ECODE_FTYPE, NM_ECODE_NOMEM, nmFindFieldDef(), NMFTypePad, NMFTypePadTr, NMITV_FHDR_SIZE_BASE, NMITV_FID_SIZE, NMLIB_ASCII_FTYPE, NMLIB_RAISE_ERROR, NMLIB_RAISE_FIELD_ERROR, NMLIB_WARNING, and nmLookupITVUnpacker().

Referenced by nmUnpackITVMsg(), nmUnpackITVMsgDebug(), and nmUnpackITVStruct().

{
  const NMFieldDef_T *pFieldDef;
  NMUnpackFunc_T      fnUnpack = NULL;
  byte_t              bNoExec;
  byte_t              byFId;
  byte_t              byFType;
  void               *pVal;
  int                 n = 0;
  int                 k;

  bNoExec = pCtl->m_bNoExec;

  while( (uCount > 0) && (n+NMITV_FID_SIZE < uMsgLen) )
  {
    byFId = buf[n]; // field id

    // Padding (reserved packed id)
    if( byFId ==  NMFTypePadTr )
    {
      byFType   = (byte_t)NMFTypePad; // internal pad field type
      pFieldDef = NULL;
      pVal      = NULL;
    }

    // ITV field
    else
    {
      if( n+NMITV_FHDR_SIZE_BASE >= uMsgLen )
      {
        NMLIB_RAISE_ERROR(NM_ECODE_NOMEM,
                "msg_len=%zu, msg_id=%u", uMsgLen, pMsgDef->m_eMsgId);
      }

      byFType = buf[n+1]; // field type

      if( (pFieldDef = nmFindFieldDef(pMsgDef, byFId)) == NULL )
      {
        pCtl->m_bNoExec = true;
        pVal = NULL;
        NMLIB_WARNING("Unknown fid=%u @byte=%d - ignoring.", (uint_t)byFId, n);
      }
      else if( pFieldDef->m_eFType != (NMFType_T)byFType )
      {
        NMLIB_RAISE_ERROR(NM_ECODE_EMSG,
           "Field definition ftype='%c'(0x%02x) != receive ftype='%c'(0x%02x).",
           NMLIB_ASCII_FTYPE(pFieldDef->m_eFType), pFieldDef->m_eFType,
           NMLIB_ASCII_FTYPE(byFType), byFType);
      }

      pVal = pStruct + pFieldDef->m_uOffset;
    }
    
    fnUnpack  = nmLookupITVUnpacker(byFType);

    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;
    }

    n += k;

    pCtl->m_bNoExec = bNoExec;

    uCount--;
  }

  if( uCount > 0 )
  {
    NMLIB_RAISE_ERROR(NM_ECODE_EMSG,
                "%s(%u): %u field(s) left unparsed - no more message",
                pMsgDef->m_sMsgName, pMsgDef->m_eMsgId, uCount);
  }

  return n;
}

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

static

Unpack variable length string ITV 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 1821 of file nmLibPackITV.c.

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

{
  size_t    uCount;
  size_t    uMaxCount;
  size_t    uFSize;
  char     *sVal;
  int       n;

  n = NMITV_FHDR_SIZE_STRING;

  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu, fhdr_size=%u", bufSize, n);
  }

  // string subheader
  uCount      = (size_t)buf[2];

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

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

  // not enough space in buffer for string
  else if( uFSize > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fsize=%zu", bufSize, uFSize);
  }

  // success
  else
  {
    memcpy(sVal, buf+n, uCount);
    sVal[uCount] = 0;

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

    return (int)uFSize;
  }
}

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

static

Unpack structure ITV 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 1883 of file nmLibPackITV.c.

References _nm_msg_def_struct::m_sMsgName, NMFieldThis_T::m_struct, _nm_field_def_struct::m_this, NMCtl_T::m_uDepth, NM_ECODE_NOMEM, NMITV_FHDR_SIZE_STRUCT, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, and nmUnpackITVStream().

{
  const NMMsgDef_T *pStructDef;   // structure definition
  size_t            uCount;       // struct field count
  int               n;            // byte count/error code
  int               k;            // subbyte count/error code

  n = NMITV_FHDR_SIZE_STRUCT;

  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu, fhdr_size=%u", bufSize, n);
  }

  // number of fields in struct
  uCount = (size_t)buf[2];  // fix

  pStructDef  = pFieldDef->m_this.m_struct;

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl, "structdef %s, member_count=%u",
      pStructDef->m_sMsgName, buf[2]); //pStructDef->m_uCount);

  pCtl->m_uDepth++;

  // copy struct field value
  k = nmUnpackITVStream(pStructDef, &buf[n], bufSize-(size_t)n, uCount,
                                  pVal, eEndian, pCtl);

  pCtl->m_uDepth--;

  return k>=0? n+k: k;
}

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

static

Unpack an unsigned 16-bit ITV 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 1316 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_U16, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackITVNoExec(), and nmUnpackU16().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_U16,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackU16(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Unpack an unsigned 32-bit ITV 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 1416 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_U32, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackITVNoExec(), and nmUnpackU32().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_U32,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackU32(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Unpack an unsigned 64-bit ITV 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 1516 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_U64, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackITVNoExec(), and nmUnpackU64().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_U64,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackU64(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Unpack an unsigned 8-bit ITV 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 1215 of file nmLibPackITV.c.

References NMCtl_T::m_bNoExec, NMCtl_T::m_bNoHdr, NM_ECODE_NOMEM, NMFVAL_LEN_U8, NMITV_FHDR_SIZE_SIMPLE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, nmUnpackITVNoExec(), and nmUnpackU8().

{
  int       n;    // byte count/error code
  int       k;    // subbyte count/error code

  // header size
  n = pCtl->m_bNoHdr? 0: NMITV_FHDR_SIZE_SIMPLE;

  // not enough input buffer for header
  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu < fhdr_size=%u", bufSize, n);
  }

  // ignore this field
  else if( pCtl->m_bNoExec )
  {
    return nmUnpackITVNoExec(pFieldDef, buf, bufSize, (size_t)n+NMFVAL_LEN_U8,
                              pCtl);
  }

  // try to unpack value
  else if( (k = nmUnpackU8(&buf[n], bufSize-(size_t)n, pVal, eEndian)) < 0 )
  {
    return k;
  }

  // success
  else
  {
    n += k;

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

    return n;
  }
}

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

static

Unpack variable length vector ITV 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 1930 of file nmLibPackITV.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_EMSG, NM_ECODE_FTYPE, NM_ECODE_NOMEM, NM_ECODE_RANGE, NMFTYPE_IS_SIMPLE, NMITV_FHDR_SIZE_VECTOR, NMLIB_ASCII_FTYPE, NMLIB_RAISE_FIELD_ERROR, NMLIB_TRACE_FIELD, and nmLookupITVUnpacker().

{
  size_t              uCount;
  byte_t              byElemFType;
  size_t              uMaxCount;
  size_t              uElemSize;
  const NMFieldDef_T *pElemDef;
  NMVec_T            *pVec;
  void               *pItem;
  NMUnpackFunc_T      fnUnpack = NULL;
  int                 n = NMITV_FHDR_SIZE_VECTOR;
  int                 k;
  size_t              i;

  n = NMITV_FHDR_SIZE_VECTOR;

  if( n > bufSize )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_NOMEM, pFieldDef,
        "buf_size=%zu, fhdr_size=%u", bufSize, n);
  }

  // vector subheader 
  uCount      = (size_t)buf[2];
  byElemFType = (byte_t)buf[3];

  // 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);
  fnUnpack  = nmLookupITVUnpacker(pElemDef->m_eFType);

  // received vector type mismatch with definition
  if( byElemFType != (byte_t)pElemDef->m_eFType )
  {
    NMLIB_RAISE_FIELD_ERROR(NM_ECODE_EMSG, pFieldDef,
           "vector_elem_ftype='%c'(0x%02x) != rcv'd ftype='%c'(0x%02x).",
           NMLIB_ASCII_FTYPE(pElemDef->m_eFType), pElemDef->m_eFType,
           NMLIB_ASCII_FTYPE(byElemFType), byElemFType);
  }

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

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

  NMLIB_TRACE_FIELD(pFieldDef, buf, n, pCtl,
        "vector_count=%zu, vector_elem_ftype='%c'(0x%02x)",
         uCount, NMLIB_ASCII_FTYPE(byElemFType), byElemFType);

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

  pCtl->m_uDepth++;

  // unpack field into vector field
  for(i=0; i<uCount; ++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--;
  pCtl->m_bNoHdr = false;

  // actual number of vector items
  pVec->m_uCount = n>0? uCount: 0;

  return n;
}

Variable Documentation

NMLookupTblEntry_T NMITVLookupTbl[]

static

Initial value:

=
{
  {NMFTypeBool,       nmPackITVBool,    nmUnpackITVBool},         
  {NMFTypeU8,         nmPackITVU8,      nmUnpackITVU8},           
  {NMFTypeF64,        nmPackITVF64,     nmUnpackITVF64},          
  {NMFTypeU16,        nmPackITVU16,     nmUnpackITVU16},          
  {NMFTypeU32,        nmPackITVU32,     nmUnpackITVU32},          
  {NMFTypeP64,        nmPackITVP64,     nmUnpackITVP64},          
  {NMFTypeU64,        nmPackITVU64,     nmUnpackITVU64},          
  {NMFTypeVector,     nmPackITVVector,  nmUnpackITVVector},       
  {NMFTypeS8,         nmPackITVS8,      nmUnpackITVS8},           
  {NMFTypeChar,       nmPackITVU8,      nmUnpackITVU8},           
  {NMFTypeF32,        nmPackITVF32,     nmUnpackITVF32},          
  {NMFTypeS16,        nmPackITVS16,     nmUnpackITVS16},          
  {NMFTypeS32,        nmPackITVS32,     nmUnpackITVS32},          
  {NMFTypeP32,        nmPackITVP32,     nmUnpackITVP32},          
  {NMFTypeS64,        nmPackITVS64,     nmUnpackITVS64},          
  {NMFTypeString,     nmPackITVString,  nmUnpackITVString},       
  {NMFTypePad,        nmPackITVPad,     nmUnpackITVPad},          
  {NMFTypeStruct,     nmPackITVStruct,  nmUnpackITVStruct}        
}

ITV Info Lookup Table

Warning

Keep in asending order by ftype.

Definition at line 2145 of file nmLibPackITV.c.