bsNullMsgs.c

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: bsNullMsgs.c
//
/*!
 * \file
 *
 * \brief BotSense bsProxy server - client /dev/null NetMsgs XML Definition
 *
 * \warning This file was auto-generated on 2018.08.10 13:54:23 from the NetMsgs
 * XML specification bsNullMsgs.xml.
 *
 * \par Copyright:
 * (C) 2018. RoadNarrows LLC
 * (http://www.roadnarrows.com)
 * All Rights Reserved
 */
///////////////////////////////////////////////////////////////////////////////


#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/netmsgs.h"

#include "botsense/bsNullMsgs.h"

#ifndef EOFDEF
/*! End of Field Definition entry. */
#define EOFDEF {NULL, 0, NMFTypeNone, 0, }
#endif // EOFDEF


//-----------------------------------------------------------------------------
// Private Interface
//-----------------------------------------------------------------------------


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsNullReqWrite Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsNullReqWritewritebuf Field Definitions
 */
static const NMFieldDef_T BsNullReqWritewritebufFieldDef[] =
{
  {
    .m_sFName                 = "writebuf",
    .m_eFId                   = 0,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = (size_t)0,
    .m_this.m_u8.m_bits       = (byte_t)(0),
    .m_this.m_u8.m_valMin     = (byte_t)(0),
    .m_this.m_u8.m_valMax     = (byte_t)(0),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
  EOFDEF
};

/*!
 * BsNullReqWrite Field Id Enumeration
 */
typedef enum
{
  BsNullReqWriteFIdReserved             = 0,    ///< reserved field id
  BsNullReqWriteFIdwritebuf             = 1,    ///< writebuf field id
  BsNullReqWriteFIdNumOf                = 2     ///< number of fields
} BsNullReqWriteFId_T;

/*!
 * BsNullReqWrite Field Definitions
 */
static const NMFieldDef_T BsNullReqWriteFieldDefs[] =
{
  {
    .m_sFName                 = "writebuf",
    .m_eFId                   = BsNullReqWriteFIdwritebuf,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsNullReqWrite_T, m_writebuf),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSNULL_REQWRITE_WRITEBUF_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsNullReqWritewritebufFieldDef,
  },
  EOFDEF
};

/*!
 * BsNullReqWrite Message Definition
 */
static const NMMsgDef_T BsNullReqWriteMsgDef =
{
  .m_sMsgName         = "BsNullReqWrite",
  .m_eMsgId           = BsNullMsgIdReqWrite,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsNullReqWriteFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsNullRspWrite Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsNullRspWrite Field Id Enumeration
 */
typedef enum
{
  BsNullRspWriteFIdReserved             = 0,    ///< reserved field id
  BsNullRspWriteFIdbyteswritten         = 1,    ///< byteswritten field id
  BsNullRspWriteFIdNumOf                = 2     ///< number of fields
} BsNullRspWriteFId_T;

/*!
 * BsNullRspWrite Field Definitions
 */
static const NMFieldDef_T BsNullRspWriteFieldDefs[] =
{
  {
    .m_sFName                 = "byteswritten",
    .m_eFId                   = BsNullRspWriteFIdbyteswritten,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsNullRspWrite_T, m_byteswritten),
    .m_this.m_u8.m_bits       = (byte_t)(0),
    .m_this.m_u8.m_valMin     = (byte_t)(0),
    .m_this.m_u8.m_valMax     = (byte_t)(0),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
  EOFDEF
};

/*!
 * BsNullRspWrite Message Definition
 */
static const NMMsgDef_T BsNullRspWriteMsgDef =
{
  .m_sMsgName         = "BsNullRspWrite",
  .m_eMsgId           = BsNullMsgIdRspWrite,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsNullRspWriteFieldDefs
};


//-----------------------------------------------------------------------------
// Public Interface
//-----------------------------------------------------------------------------

/*!
 * BsNull Message Definition Look-Up Table. Indexed by BsNullMsgId_T enum.
 */
const NMMsgDef_T *BsNullMsgDefLookupTbl[] =
{
  NULL,                                 ///< [BsNullMsgIdNone]
  &BsNullReqWriteMsgDef,                ///< [BsNullMsgIdReqWrite]
  &BsNullRspWriteMsgDef,                ///< [BsNullMsgIdRspWrite]
  NULL                                  ///< [BsNullMsgIdNumOf]
};

/*!
 * BsNull Message Maximum Size Look-Up Table. Indexed by BsNullMsgId_T enum.
 */
size_t BsNullMsgMaxLenLookupTbl[] =
{
  (size_t)(0),                          ///< [BsNullMsgIdNone]
  (size_t)(262),                        ///< [BsNullMsgIdReqWrite]
  (size_t)(6),                          ///< [BsNullMsgIdRspWrite]
  (size_t)(0)                           ///< [BsNullMsgIdNumOf]
};


//-----------------------------------------------------------------------------
// Functions
//-----------------------------------------------------------------------------

/*!
 * \brief Look up the message definition associated with the message id.
 * 
 * \param eMsgId          Message Id.
 * 
 * \return
 * On success, returns the pointer to the NMMsgDef_T.
 * On error, NULL is returned.
 */
const NMMsgDef_T * BsNullLookupMsgDef( BsNullMsgId_T eMsgId )
{
  if( (uint_t)eMsgId >= (uint_t)BsNullMsgIdNumOf )
  {
    return NULL;
  }
  else
  {
    return BsNullMsgDefLookupTbl[(uint_t)eMsgId];
  }
}

/*!
 * \brief Look up the message maximum length associated with the message id.
 * 
 * The maximum length is the total number of packed bytes possible for the
 * given message. The message may be much shorter.
 * 
 * \param eMsgId          Message Id.
 * 
 * \return
 * On success, returns the number of bytes.
 * On error, 0 is returned.
 */
size_t BsNullLookupMsgMaxLen( BsNullMsgId_T eMsgId )
{
  if( (uint_t)eMsgId >= (uint_t)BsNullMsgIdNumOf )
  {
    return (size_t)0;
  }
  else
  {
    return BsNullMsgMaxLenLookupTbl[(uint_t)eMsgId];
  }
}

/*!
 * \brief Pack a ITV message in big-endian byte order.
 * 
 * \param eMsgId          Message Id.
 * \param [in] pStruct    Pointer to the associated, populated message
 *                        structure.
 * \param [out] buf       Output message buffer.
 * \param bufSize         Size of output buffer.
 * \param bTrace          Do [not] trace packing.
 * 
 * \return
 * On success, returns the number of bytes packed.
 * On error, returns the appropriate < 0 negated NM_ECODE.
 */
int BsNullPackMsg( BsNullMsgId_T eMsgId,
                   void * pStruct,
                   byte_t buf[],
                   size_t bufSize,
                   bool_t bTrace )
{
  const  NMMsgDef_T  *pMsgDef;
  
  if( (pMsgDef = BsNullLookupMsgDef(eMsgId)) == NULL )
  {
    LOGERROR("%s(ecode=%d): msgid=%u.", 
              nmStrError(NM_ECODE_MSGID), NM_ECODE_MSGID, eMsgId);
    return -NM_ECODE_MSGID;
  }
  
  if( bTrace )
  {
    return nmPackITVMsgDebug(pMsgDef, pStruct, buf, bufSize, NMEndianBig);
  }
  else
  {
    return nmPackITVMsg(pMsgDef, pStruct, buf, bufSize, NMEndianBig);
  }
}

/*!
 * \brief Unpack a ITV message in big-endian byte order.
 * 
 * \param eMsgId          Message Id.
 * \param [in] buf        Input message buffer.
 * \param uMsgLen         Length of message (bytes) in input buffer.
 * \param [out] pStruct   Pointer to the associated message structure.
 * \param bTrace          Do [not] trace packing.
 * 
 * \return
 * On success, returns the number of bytes unpacked.
 * On error, returns the appropriate < 0 negated NM_ECODE.
 */
int BsNullUnpackMsg( BsNullMsgId_T eMsgId,
                     byte_t buf[],
                     size_t uMsgLen,
                     void * pStruct,
                     bool_t bTrace )
{
  const  NMMsgDef_T  *pMsgDef;
  
  if( (pMsgDef = BsNullLookupMsgDef(eMsgId)) == NULL )
  {
    LOGERROR("%s(ecode=%d): msgid=%u.", 
              nmStrError(NM_ECODE_MSGID), NM_ECODE_MSGID, eMsgId);
    return -NM_ECODE_MSGID;
  }
  
  if( bTrace )
  {
    return nmUnpackITVMsgDebug(pMsgDef, buf, uMsgLen, pStruct, NMEndianBig);
  }
  else
  {
    return nmUnpackITVMsg(pMsgDef, buf, uMsgLen, pStruct, NMEndianBig);
  }
}