bsProxyMsgs.c

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: bsProxyMsgs.c
//
/*!
 * \file
 *
 * \brief BotSense client application - bsProxy server-terminated core messages.
 *
 * \warning This file was auto-generated on 2018.08.10 13:54:22 from the NetMsgs
 * XML specification bsProxyMsgs.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/bsProxyMsgs.h"

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


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


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyRspOk Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyRspOk Field Id Enumeration
 */
typedef enum
{
  BsProxyRspOkFIdReserved               = 0,    ///< reserved field id
  BsProxyRspOkFIdNumOf                  = 1     ///< number of fields
} BsProxyRspOkFId_T;

/*!
 * BsProxyRspOk Field Definitions
 */
static const NMFieldDef_T BsProxyRspOkFieldDefs[] =
{
  EOFDEF
};

/*!
 * BsProxyRspOk Message Definition
 */
static const NMMsgDef_T BsProxyRspOkMsgDef =
{
  .m_sMsgName         = "BsProxyRspOk",
  .m_eMsgId           = BsProxyMsgIdRspOk,
  .m_uCount           = (size_t)(0),
  .m_pFields          = BsProxyRspOkFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyRspErr Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyRspErr Field Id Enumeration
 */
typedef enum
{
  BsProxyRspErrFIdReserved              = 0,    ///< reserved field id
  BsProxyRspErrFIdecode                 = 1,    ///< ecode field id
  BsProxyRspErrFIdemsg                  = 2,    ///< emsg field id
  BsProxyRspErrFIdNumOf                 = 3     ///< number of fields
} BsProxyRspErrFId_T;

/*!
 * BsProxyRspErr Field Definitions
 */
static const NMFieldDef_T BsProxyRspErrFieldDefs[] =
{
  {
    .m_sFName                 = "ecode",
    .m_eFId                   = BsProxyRspErrFIdecode,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsProxyRspErr_T, m_ecode),
    .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),
  },
  {
    .m_sFName                 = "emsg",
    .m_eFId                   = BsProxyRspErrFIdemsg,
    .m_eFType                 = NMFTypeString,
    .m_uOffset                = memberoffset(BsProxyRspErr_T, m_emsg),
    .m_this.m_string.m_uMaxCount
                              = (size_t)BSPROXY_RSPERR_EMSG_LEN+1,
    .m_this.m_string.m_sConst = (char *)(NULL),
  },
  EOFDEF
};

/*!
 * BsProxyRspErr Message Definition
 */
static const NMMsgDef_T BsProxyRspErrMsgDef =
{
  .m_sMsgName         = "BsProxyRspErr",
  .m_eMsgId           = BsProxyMsgIdRspErr,
  .m_uCount           = (size_t)(2),
  .m_pFields          = BsProxyRspErrFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyReqLoopback Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyReqLoopback Field Id Enumeration
 */
typedef enum
{
  BsProxyReqLoopbackFIdReserved         = 0,    ///< reserved field id
  BsProxyReqLoopbackFIdcdata            = 1,    ///< cdata field id
  BsProxyReqLoopbackFIdNumOf            = 2     ///< number of fields
} BsProxyReqLoopbackFId_T;

/*!
 * BsProxyReqLoopback Field Definitions
 */
static const NMFieldDef_T BsProxyReqLoopbackFieldDefs[] =
{
  {
    .m_sFName                 = "cdata",
    .m_eFId                   = BsProxyReqLoopbackFIdcdata,
    .m_eFType                 = NMFTypeString,
    .m_uOffset                = memberoffset(BsProxyReqLoopback_T, m_cdata),
    .m_this.m_string.m_uMaxCount
                              = (size_t)BSPROXY_REQLOOPBACK_CDATA_LEN+1,
    .m_this.m_string.m_sConst = (char *)(NULL),
  },
  EOFDEF
};

/*!
 * BsProxyReqLoopback Message Definition
 */
static const NMMsgDef_T BsProxyReqLoopbackMsgDef =
{
  .m_sMsgName         = "BsProxyReqLoopback",
  .m_eMsgId           = BsProxyMsgIdReqLoopback,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsProxyReqLoopbackFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyRspLoopback Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyRspLoopback Field Id Enumeration
 */
typedef enum
{
  BsProxyRspLoopbackFIdReserved         = 0,    ///< reserved field id
  BsProxyRspLoopbackFIdcdata            = 1,    ///< cdata field id
  BsProxyRspLoopbackFIdNumOf            = 2     ///< number of fields
} BsProxyRspLoopbackFId_T;

/*!
 * BsProxyRspLoopback Field Definitions
 */
static const NMFieldDef_T BsProxyRspLoopbackFieldDefs[] =
{
  {
    .m_sFName                 = "cdata",
    .m_eFId                   = BsProxyRspLoopbackFIdcdata,
    .m_eFType                 = NMFTypeString,
    .m_uOffset                = memberoffset(BsProxyRspLoopback_T, m_cdata),
    .m_this.m_string.m_uMaxCount
                              = (size_t)BSPROXY_RSPLOOPBACK_CDATA_LEN+1,
    .m_this.m_string.m_sConst = (char *)(NULL),
  },
  EOFDEF
};

/*!
 * BsProxyRspLoopback Message Definition
 */
static const NMMsgDef_T BsProxyRspLoopbackMsgDef =
{
  .m_sMsgName         = "BsProxyRspLoopback",
  .m_eMsgId           = BsProxyMsgIdRspLoopback,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsProxyRspLoopbackFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyReqSetLogging Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyReqSetLogging Field Id Enumeration
 */
typedef enum
{
  BsProxyReqSetLoggingFIdReserved       = 0,    ///< reserved field id
  BsProxyReqSetLoggingFIdlevel          = 1,    ///< level field id
  BsProxyReqSetLoggingFIdNumOf          = 2     ///< number of fields
} BsProxyReqSetLoggingFId_T;

/*!
 * BsProxyReqSetLogging Field Definitions
 */
static const NMFieldDef_T BsProxyReqSetLoggingFieldDefs[] =
{
  {
    .m_sFName                 = "level",
    .m_eFId                   = BsProxyReqSetLoggingFIdlevel,
    .m_eFType                 = NMFTypeS32,
    .m_uOffset                = memberoffset(BsProxyReqSetLogging_T, m_level),
    .m_this.m_u32.m_bits      = (byte_t)(0),
    .m_this.m_u32.m_valMin    = (uint_t)(0),
    .m_this.m_u32.m_valMax    = (uint_t)(0),
    .m_this.m_u32.m_valConst  = (uint_t)(0),
  },
  EOFDEF
};

/*!
 * BsProxyReqSetLogging Message Definition
 */
static const NMMsgDef_T BsProxyReqSetLoggingMsgDef =
{
  .m_sMsgName         = "BsProxyReqSetLogging",
  .m_eMsgId           = BsProxyMsgIdReqSetLogging,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsProxyReqSetLoggingFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyReqGetVersion Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyReqGetVersion Field Id Enumeration
 */
typedef enum
{
  BsProxyReqGetVersionFIdReserved       = 0,    ///< reserved field id
  BsProxyReqGetVersionFIdNumOf          = 1     ///< number of fields
} BsProxyReqGetVersionFId_T;

/*!
 * BsProxyReqGetVersion Field Definitions
 */
static const NMFieldDef_T BsProxyReqGetVersionFieldDefs[] =
{
  EOFDEF
};

/*!
 * BsProxyReqGetVersion Message Definition
 */
static const NMMsgDef_T BsProxyReqGetVersionMsgDef =
{
  .m_sMsgName         = "BsProxyReqGetVersion",
  .m_eMsgId           = BsProxyMsgIdReqGetVersion,
  .m_uCount           = (size_t)(0),
  .m_pFields          = BsProxyReqGetVersionFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyRspGetVersion Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyRspGetVersion Field Id Enumeration
 */
typedef enum
{
  BsProxyRspGetVersionFIdReserved       = 0,    ///< reserved field id
  BsProxyRspGetVersionFIdversion        = 1,    ///< version field id
  BsProxyRspGetVersionFIdNumOf          = 2     ///< number of fields
} BsProxyRspGetVersionFId_T;

/*!
 * BsProxyRspGetVersion Field Definitions
 */
static const NMFieldDef_T BsProxyRspGetVersionFieldDefs[] =
{
  {
    .m_sFName                 = "version",
    .m_eFId                   = BsProxyRspGetVersionFIdversion,
    .m_eFType                 = NMFTypeString,
    .m_uOffset                = memberoffset(BsProxyRspGetVersion_T, m_version),
    .m_this.m_string.m_uMaxCount
                              = (size_t)BSPROXY_RSPGETVERSION_VERSION_LEN+1,
    .m_this.m_string.m_sConst = (char *)(NULL),
  },
  EOFDEF
};

/*!
 * BsProxyRspGetVersion Message Definition
 */
static const NMMsgDef_T BsProxyRspGetVersionMsgDef =
{
  .m_sMsgName         = "BsProxyRspGetVersion",
  .m_eMsgId           = BsProxyMsgIdRspGetVersion,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsProxyRspGetVersionFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyReqMsgTrace Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyReqMsgTrace Field Id Enumeration
 */
typedef enum
{
  BsProxyReqMsgTraceFIdReserved         = 0,    ///< reserved field id
  BsProxyReqMsgTraceFIdvconn            = 1,    ///< vconn field id
  BsProxyReqMsgTraceFIdtrace            = 2,    ///< trace field id
  BsProxyReqMsgTraceFIdNumOf            = 3     ///< number of fields
} BsProxyReqMsgTraceFId_T;

/*!
 * BsProxyReqMsgTrace Field Definitions
 */
static const NMFieldDef_T BsProxyReqMsgTraceFieldDefs[] =
{
  {
    .m_sFName                 = "vconn",
    .m_eFId                   = BsProxyReqMsgTraceFIdvconn,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsProxyReqMsgTrace_T, m_vconn),
    .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),
  },
  {
    .m_sFName                 = "trace",
    .m_eFId                   = BsProxyReqMsgTraceFIdtrace,
    .m_eFType                 = NMFTypeBool,
    .m_uOffset                = memberoffset(BsProxyReqMsgTrace_T, m_trace),
  },
  EOFDEF
};

/*!
 * BsProxyReqMsgTrace Message Definition
 */
static const NMMsgDef_T BsProxyReqMsgTraceMsgDef =
{
  .m_sMsgName         = "BsProxyReqMsgTrace",
  .m_eMsgId           = BsProxyMsgIdReqMsgTrace,
  .m_uCount           = (size_t)(2),
  .m_pFields          = BsProxyReqMsgTraceFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyReqDevOpen Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyReqDevOpenargbuf Field Definitions
 */
static const NMFieldDef_T BsProxyReqDevOpenargbufFieldDef[] =
{
  {
    .m_sFName                 = "argbuf",
    .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
};

/*!
 * BsProxyReqDevOpen Field Id Enumeration
 */
typedef enum
{
  BsProxyReqDevOpenFIdReserved          = 0,    ///< reserved field id
  BsProxyReqDevOpenFIdtrace             = 1,    ///< trace field id
  BsProxyReqDevOpenFIddevname           = 2,    ///< devname field id
  BsProxyReqDevOpenFIdmodname           = 3,    ///< modname field id
  BsProxyReqDevOpenFIdargbuf            = 4,    ///< argbuf field id
  BsProxyReqDevOpenFIdNumOf             = 5     ///< number of fields
} BsProxyReqDevOpenFId_T;

/*!
 * BsProxyReqDevOpen Field Definitions
 */
static const NMFieldDef_T BsProxyReqDevOpenFieldDefs[] =
{
  {
    .m_sFName                 = "trace",
    .m_eFId                   = BsProxyReqDevOpenFIdtrace,
    .m_eFType                 = NMFTypeBool,
    .m_uOffset                = memberoffset(BsProxyReqDevOpen_T, m_trace),
  },
  {
    .m_sFName                 = "devname",
    .m_eFId                   = BsProxyReqDevOpenFIddevname,
    .m_eFType                 = NMFTypeString,
    .m_uOffset                = memberoffset(BsProxyReqDevOpen_T, m_devname),
    .m_this.m_string.m_uMaxCount
                              = (size_t)BSPROXY_REQDEVOPEN_DEVNAME_LEN+1,
    .m_this.m_string.m_sConst = (char *)(NULL),
  },
  {
    .m_sFName                 = "modname",
    .m_eFId                   = BsProxyReqDevOpenFIdmodname,
    .m_eFType                 = NMFTypeString,
    .m_uOffset                = memberoffset(BsProxyReqDevOpen_T, m_modname),
    .m_this.m_string.m_uMaxCount
                              = (size_t)BSPROXY_REQDEVOPEN_MODNAME_LEN+1,
    .m_this.m_string.m_sConst = (char *)(NULL),
  },
  {
    .m_sFName                 = "argbuf",
    .m_eFId                   = BsProxyReqDevOpenFIdargbuf,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsProxyReqDevOpen_T, m_argbuf),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSPROXY_REQDEVOPEN_ARGBUF_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsProxyReqDevOpenargbufFieldDef,
  },
  EOFDEF
};

/*!
 * BsProxyReqDevOpen Message Definition
 */
static const NMMsgDef_T BsProxyReqDevOpenMsgDef =
{
  .m_sMsgName         = "BsProxyReqDevOpen",
  .m_eMsgId           = BsProxyMsgIdReqDevOpen,
  .m_uCount           = (size_t)(4),
  .m_pFields          = BsProxyReqDevOpenFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyRspDevOpen Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyRspDevOpen Field Id Enumeration
 */
typedef enum
{
  BsProxyRspDevOpenFIdReserved          = 0,    ///< reserved field id
  BsProxyRspDevOpenFIdvconn             = 1,    ///< vconn field id
  BsProxyRspDevOpenFIdNumOf             = 2     ///< number of fields
} BsProxyRspDevOpenFId_T;

/*!
 * BsProxyRspDevOpen Field Definitions
 */
static const NMFieldDef_T BsProxyRspDevOpenFieldDefs[] =
{
  {
    .m_sFName                 = "vconn",
    .m_eFId                   = BsProxyRspDevOpenFIdvconn,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsProxyRspDevOpen_T, m_vconn),
    .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
};

/*!
 * BsProxyRspDevOpen Message Definition
 */
static const NMMsgDef_T BsProxyRspDevOpenMsgDef =
{
  .m_sMsgName         = "BsProxyRspDevOpen",
  .m_eMsgId           = BsProxyMsgIdRspDevOpen,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsProxyRspDevOpenFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyReqDevClose Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyReqDevClose Field Id Enumeration
 */
typedef enum
{
  BsProxyReqDevCloseFIdReserved         = 0,    ///< reserved field id
  BsProxyReqDevCloseFIdvconn            = 1,    ///< vconn field id
  BsProxyReqDevCloseFIdNumOf            = 2     ///< number of fields
} BsProxyReqDevCloseFId_T;

/*!
 * BsProxyReqDevClose Field Definitions
 */
static const NMFieldDef_T BsProxyReqDevCloseFieldDefs[] =
{
  {
    .m_sFName                 = "vconn",
    .m_eFId                   = BsProxyReqDevCloseFIdvconn,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsProxyReqDevClose_T, m_vconn),
    .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
};

/*!
 * BsProxyReqDevClose Message Definition
 */
static const NMMsgDef_T BsProxyReqDevCloseMsgDef =
{
  .m_sMsgName         = "BsProxyReqDevClose",
  .m_eMsgId           = BsProxyMsgIdReqDevClose,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsProxyReqDevCloseFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyReqGetVConnList Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyReqGetVConnList Field Id Enumeration
 */
typedef enum
{
  BsProxyReqGetVConnListFIdReserved     = 0,    ///< reserved field id
  BsProxyReqGetVConnListFIdNumOf        = 1     ///< number of fields
} BsProxyReqGetVConnListFId_T;

/*!
 * BsProxyReqGetVConnList Field Definitions
 */
static const NMFieldDef_T BsProxyReqGetVConnListFieldDefs[] =
{
  EOFDEF
};

/*!
 * BsProxyReqGetVConnList Message Definition
 */
static const NMMsgDef_T BsProxyReqGetVConnListMsgDef =
{
  .m_sMsgName         = "BsProxyReqGetVConnList",
  .m_eMsgId           = BsProxyMsgIdReqGetVConnList,
  .m_uCount           = (size_t)(0),
  .m_pFields          = BsProxyReqGetVConnListFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyRspGetVConnList Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyRspGetVConnListvconn Field Definitions
 */
static const NMFieldDef_T BsProxyRspGetVConnListvconnFieldDef[] =
{
  {
    .m_sFName                 = "vconn",
    .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
};

/*!
 * BsProxyRspGetVConnList Field Id Enumeration
 */
typedef enum
{
  BsProxyRspGetVConnListFIdReserved     = 0,    ///< reserved field id
  BsProxyRspGetVConnListFIdvconn        = 1,    ///< vconn field id
  BsProxyRspGetVConnListFIdNumOf        = 2     ///< number of fields
} BsProxyRspGetVConnListFId_T;

/*!
 * BsProxyRspGetVConnList Field Definitions
 */
static const NMFieldDef_T BsProxyRspGetVConnListFieldDefs[] =
{
  {
    .m_sFName                 = "vconn",
    .m_eFId                   = BsProxyRspGetVConnListFIdvconn,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsProxyRspGetVConnList_T, m_vconn),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSPROXY_VCONN_CLIENT_MAX,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsProxyRspGetVConnListvconnFieldDef,
  },
  EOFDEF
};

/*!
 * BsProxyRspGetVConnList Message Definition
 */
static const NMMsgDef_T BsProxyRspGetVConnListMsgDef =
{
  .m_sMsgName         = "BsProxyRspGetVConnList",
  .m_eMsgId           = BsProxyMsgIdRspGetVConnList,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsProxyRspGetVConnListFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyReqGetVConnInfo Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyReqGetVConnInfo Field Id Enumeration
 */
typedef enum
{
  BsProxyReqGetVConnInfoFIdReserved     = 0,    ///< reserved field id
  BsProxyReqGetVConnInfoFIdvconn        = 1,    ///< vconn field id
  BsProxyReqGetVConnInfoFIdNumOf        = 2     ///< number of fields
} BsProxyReqGetVConnInfoFId_T;

/*!
 * BsProxyReqGetVConnInfo Field Definitions
 */
static const NMFieldDef_T BsProxyReqGetVConnInfoFieldDefs[] =
{
  {
    .m_sFName                 = "vconn",
    .m_eFId                   = BsProxyReqGetVConnInfoFIdvconn,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsProxyReqGetVConnInfo_T, m_vconn),
    .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
};

/*!
 * BsProxyReqGetVConnInfo Message Definition
 */
static const NMMsgDef_T BsProxyReqGetVConnInfoMsgDef =
{
  .m_sMsgName         = "BsProxyReqGetVConnInfo",
  .m_eMsgId           = BsProxyMsgIdReqGetVConnInfo,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsProxyReqGetVConnInfoFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsProxyRspGetVConnInfo Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsProxyRspGetVConnInfo Field Id Enumeration
 */
typedef enum
{
  BsProxyRspGetVConnInfoFIdReserved     = 0,    ///< reserved field id
  BsProxyRspGetVConnInfoFIdvconn        = 1,    ///< vconn field id
  BsProxyRspGetVConnInfoFIdrd           = 2,    ///< rd field id
  BsProxyRspGetVConnInfoFIdclient       = 3,    ///< client field id
  BsProxyRspGetVConnInfoFIddevuri       = 4,    ///< devuri field id
  BsProxyRspGetVConnInfoFIdmoduri       = 5,    ///< moduri field id
  BsProxyRspGetVConnInfoFIdmodver       = 6,    ///< modver field id
  BsProxyRspGetVConnInfoFIdmoddate      = 7,    ///< moddate field id
  BsProxyRspGetVConnInfoFIdNumOf        = 8     ///< number of fields
} BsProxyRspGetVConnInfoFId_T;

/*!
 * BsProxyRspGetVConnInfo Field Definitions
 */
static const NMFieldDef_T BsProxyRspGetVConnInfoFieldDefs[] =
{
  {
    .m_sFName                 = "vconn",
    .m_eFId                   = BsProxyRspGetVConnInfoFIdvconn,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsProxyRspGetVConnInfo_T, m_vconn),
    .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),
  },
  {
    .m_sFName                 = "rd",
    .m_eFId                   = BsProxyRspGetVConnInfoFIdrd,
    .m_eFType                 = NMFTypeS32,
    .m_uOffset                = memberoffset(BsProxyRspGetVConnInfo_T, m_rd),
    .m_this.m_u32.m_bits      = (byte_t)(0),
    .m_this.m_u32.m_valMin    = (uint_t)(0),
    .m_this.m_u32.m_valMax    = (uint_t)(0),
    .m_this.m_u32.m_valConst  = (uint_t)(0),
  },
  {
    .m_sFName                 = "client",
    .m_eFId                   = BsProxyRspGetVConnInfoFIdclient,
    .m_eFType                 = NMFTypeString,
    .m_uOffset                = memberoffset(BsProxyRspGetVConnInfo_T, m_client),
    .m_this.m_string.m_uMaxCount
                              = (size_t)BSPROXY_RSPGETVCONNINFO_CLIENT_LEN+1,
    .m_this.m_string.m_sConst = (char *)(NULL),
  },
  {
    .m_sFName                 = "devuri",
    .m_eFId                   = BsProxyRspGetVConnInfoFIddevuri,
    .m_eFType                 = NMFTypeString,
    .m_uOffset                = memberoffset(BsProxyRspGetVConnInfo_T, m_devuri),
    .m_this.m_string.m_uMaxCount
                              = (size_t)BSPROXY_RSPGETVCONNINFO_DEVURI_LEN+1,
    .m_this.m_string.m_sConst = (char *)(NULL),
  },
  {
    .m_sFName                 = "moduri",
    .m_eFId                   = BsProxyRspGetVConnInfoFIdmoduri,
    .m_eFType                 = NMFTypeString,
    .m_uOffset                = memberoffset(BsProxyRspGetVConnInfo_T, m_moduri),
    .m_this.m_string.m_uMaxCount
                              = (size_t)BSPROXY_RSPGETVCONNINFO_MODURI_LEN+1,
    .m_this.m_string.m_sConst = (char *)(NULL),
  },
  {
    .m_sFName                 = "modver",
    .m_eFId                   = BsProxyRspGetVConnInfoFIdmodver,
    .m_eFType                 = NMFTypeString,
    .m_uOffset                = memberoffset(BsProxyRspGetVConnInfo_T, m_modver),
    .m_this.m_string.m_uMaxCount
                              = (size_t)BSPROXY_RSPGETVCONNINFO_MODVER_LEN+1,
    .m_this.m_string.m_sConst = (char *)(NULL),
  },
  {
    .m_sFName                 = "moddate",
    .m_eFId                   = BsProxyRspGetVConnInfoFIdmoddate,
    .m_eFType                 = NMFTypeString,
    .m_uOffset                = memberoffset(BsProxyRspGetVConnInfo_T, m_moddate),
    .m_this.m_string.m_uMaxCount
                              = (size_t)BSPROXY_RSPGETVCONNINFO_MODDATE_LEN+1,
    .m_this.m_string.m_sConst = (char *)(NULL),
  },
  EOFDEF
};

/*!
 * BsProxyRspGetVConnInfo Message Definition
 */
static const NMMsgDef_T BsProxyRspGetVConnInfoMsgDef =
{
  .m_sMsgName         = "BsProxyRspGetVConnInfo",
  .m_eMsgId           = BsProxyMsgIdRspGetVConnInfo,
  .m_uCount           = (size_t)(7),
  .m_pFields          = BsProxyRspGetVConnInfoFieldDefs
};


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

/*!
 * BsProxy Message Definition Look-Up Table. Indexed by BsProxyMsgId_T enum.
 */
const NMMsgDef_T *BsProxyMsgDefLookupTbl[] =
{
  NULL,                                 ///< [BsProxyMsgIdNone]
  &BsProxyRspOkMsgDef,                  ///< [BsProxyMsgIdRspOk]
  &BsProxyRspErrMsgDef,                 ///< [BsProxyMsgIdRspErr]
  &BsProxyReqLoopbackMsgDef,            ///< [BsProxyMsgIdReqLoopback]
  &BsProxyRspLoopbackMsgDef,            ///< [BsProxyMsgIdRspLoopback]
  &BsProxyReqSetLoggingMsgDef,          ///< [BsProxyMsgIdReqSetLogging]
  &BsProxyReqGetVersionMsgDef,          ///< [BsProxyMsgIdReqGetVersion]
  &BsProxyRspGetVersionMsgDef,          ///< [BsProxyMsgIdRspGetVersion]
  &BsProxyReqMsgTraceMsgDef,            ///< [BsProxyMsgIdReqMsgTrace]
  &BsProxyReqDevOpenMsgDef,             ///< [BsProxyMsgIdReqDevOpen]
  &BsProxyRspDevOpenMsgDef,             ///< [BsProxyMsgIdRspDevOpen]
  &BsProxyReqDevCloseMsgDef,            ///< [BsProxyMsgIdReqDevClose]
  &BsProxyReqGetVConnListMsgDef,        ///< [BsProxyMsgIdReqGetVConnList]
  &BsProxyRspGetVConnListMsgDef,        ///< [BsProxyMsgIdRspGetVConnList]
  &BsProxyReqGetVConnInfoMsgDef,        ///< [BsProxyMsgIdReqGetVConnInfo]
  &BsProxyRspGetVConnInfoMsgDef,        ///< [BsProxyMsgIdRspGetVConnInfo]
  NULL                                  ///< [BsProxyMsgIdNumOf]
};

/*!
 * BsProxy Message Maximum Size Look-Up Table. Indexed by BsProxyMsgId_T enum.
 */
size_t BsProxyMsgMaxLenLookupTbl[] =
{
  (size_t)(0),                          ///< [BsProxyMsgIdNone]
  (size_t)(3),                          ///< [BsProxyMsgIdRspOk]
  (size_t)(264),                        ///< [BsProxyMsgIdRspErr]
  (size_t)(261),                        ///< [BsProxyMsgIdReqLoopback]
  (size_t)(261),                        ///< [BsProxyMsgIdRspLoopback]
  (size_t)(9),                          ///< [BsProxyMsgIdReqSetLogging]
  (size_t)(3),                          ///< [BsProxyMsgIdReqGetVersion]
  (size_t)(261),                        ///< [BsProxyMsgIdRspGetVersion]
  (size_t)(9),                          ///< [BsProxyMsgIdReqMsgTrace]
  (size_t)(781),                        ///< [BsProxyMsgIdReqDevOpen]
  (size_t)(6),                          ///< [BsProxyMsgIdRspDevOpen]
  (size_t)(6),                          ///< [BsProxyMsgIdReqDevClose]
  (size_t)(3),                          ///< [BsProxyMsgIdReqGetVConnList]
  (size_t)((3+(4+BSPROXY_VCONN_CLIENT_MAX))),
                                        ///< [BsProxyMsgIdRspGetVConnList]
  (size_t)(6),                          ///< [BsProxyMsgIdReqGetVConnInfo]
  (size_t)(1302),                       ///< [BsProxyMsgIdRspGetVConnInfo]
  (size_t)(0)                           ///< [BsProxyMsgIdNumOf]
};


//-----------------------------------------------------------------------------
// 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 * BsProxyLookupMsgDef( BsProxyMsgId_T eMsgId )
{
  if( (uint_t)eMsgId >= (uint_t)BsProxyMsgIdNumOf )
  {
    return NULL;
  }
  else
  {
    return BsProxyMsgDefLookupTbl[(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 BsProxyLookupMsgMaxLen( BsProxyMsgId_T eMsgId )
{
  if( (uint_t)eMsgId >= (uint_t)BsProxyMsgIdNumOf )
  {
    return (size_t)0;
  }
  else
  {
    return BsProxyMsgMaxLenLookupTbl[(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 BsProxyPackMsg( BsProxyMsgId_T eMsgId,
                    void * pStruct,
                    byte_t buf[],
                    size_t bufSize,
                    bool_t bTrace )
{
  const  NMMsgDef_T  *pMsgDef;
  
  if( (pMsgDef = BsProxyLookupMsgDef(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 BsProxyUnpackMsg( BsProxyMsgId_T eMsgId,
                      byte_t buf[],
                      size_t uMsgLen,
                      void * pStruct,
                      bool_t bTrace )
{
  const  NMMsgDef_T  *pMsgDef;
  
  if( (pMsgDef = BsProxyLookupMsgDef(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);
  }
}