BotSense bsProxy server - client raw serial NetMsgs XML Definition. More...

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

Macros
#define	EOFDEF {NULL, 0, NMFTypeNone, 0, }

Enumerations
enum	BsSerialReqOpenArgsFId_T { BsSerialReqOpenArgsFIdReserved = 0, BsSerialReqOpenArgsFIdbaudrate = 1, BsSerialReqOpenArgsFIdbytesize = 2, BsSerialReqOpenArgsFIdparity = 3, BsSerialReqOpenArgsFIdstopbits = 4, BsSerialReqOpenArgsFIdrtscts = 5, BsSerialReqOpenArgsFIdxonxoff = 6, BsSerialReqOpenArgsFIdNumOf = 7 }

enum	BsSerialReqReadFId_T { BsSerialReqReadFIdReserved = 0, BsSerialReqReadFIdreadlen = 1, BsSerialReqReadFIdNumOf = 2 }

enum	BsSerialReqTransFId_T { BsSerialReqTransFIdReserved = 0, BsSerialReqTransFIdwritebuf = 1, BsSerialReqTransFIdreadlen = 2, BsSerialReqTransFIdNumOf = 3 }

enum	BsSerialRspReadFId_T { BsSerialRspReadFIdReserved = 0, BsSerialRspReadFIdreadbuf = 1, BsSerialRspReadFIdNumOf = 2 }

enum	BsSerialReqWriteFId_T { BsSerialReqWriteFIdReserved = 0, BsSerialReqWriteFIdwritebuf = 1, BsSerialReqWriteFIdNumOf = 2 }

enum	BsSerialRspWriteFId_T { BsSerialRspWriteFIdReserved = 0, BsSerialRspWriteFIdbyteswritten = 1, BsSerialRspWriteFIdNumOf = 2 }

Functions
const NMMsgDef_T *	BsSerialLookupMsgDef (BsSerialMsgId_T eMsgId)
	Look up the message definition associated with the message id. More...

size_t	BsSerialLookupMsgMaxLen (BsSerialMsgId_T eMsgId)
	Look up the message maximum length associated with the message id. More...

int	BsSerialPackMsg (BsSerialMsgId_T eMsgId, void *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a ITV message in big-endian byte order. More...

int	BsSerialUnpackMsg (BsSerialMsgId_T eMsgId, byte_t buf[], size_t uMsgLen, void *pStruct, bool_t bTrace)
	Unpack a ITV message in big-endian byte order. More...

Variables
static const NMFieldDef_T	BsSerialReqOpenArgsFieldDefs []

static const NMMsgDef_T	BsSerialReqOpenArgsMsgDef

static const NMFieldDef_T	BsSerialReqReadFieldDefs []

static const NMMsgDef_T	BsSerialReqReadMsgDef

static const NMFieldDef_T	BsSerialReqTranswritebufFieldDef []

static const NMFieldDef_T	BsSerialReqTransFieldDefs []

static const NMMsgDef_T	BsSerialReqTransMsgDef

static const NMFieldDef_T	BsSerialRspReadreadbufFieldDef []

static const NMFieldDef_T	BsSerialRspReadFieldDefs []

static const NMMsgDef_T	BsSerialRspReadMsgDef

static const NMFieldDef_T	BsSerialReqWritewritebufFieldDef []

static const NMFieldDef_T	BsSerialReqWriteFieldDefs []

static const NMMsgDef_T	BsSerialReqWriteMsgDef

static const NMFieldDef_T	BsSerialRspWriteFieldDefs []

static const NMMsgDef_T	BsSerialRspWriteMsgDef

const NMMsgDef_T *	BsSerialMsgDefLookupTbl []

size_t	BsSerialMsgMaxLenLookupTbl []

Detailed Description

BotSense bsProxy server - client raw serial NetMsgs XML Definition.

Warning: This file was auto-generated on 2018.08.10 13:54:23 from the NetMsgs XML specification bsSerialMsgs.xml.

Copyright:: (C) 2018. RoadNarrows LLC (http://www.roadnarrows.com) All Rights Reserved

Definition in file bsSerialMsgs.c.

Macro Definition Documentation

#define EOFDEF {NULL, 0, NMFTypeNone, 0, }

End of Field Definition entry.

Definition at line 29 of file bsSerialMsgs.c.

Enumeration Type Documentation

enum BsSerialReqOpenArgsFId_T

BsSerialReqOpenArgs Field Id Enumeration

Enumerator
BsSerialReqOpenArgsFIdReserved	reserved field id
BsSerialReqOpenArgsFIdbaudrate	baudrate field id
BsSerialReqOpenArgsFIdbytesize	bytesize field id
BsSerialReqOpenArgsFIdparity	parity field id
BsSerialReqOpenArgsFIdstopbits	stopbits field id
BsSerialReqOpenArgsFIdrtscts	rtscts field id
BsSerialReqOpenArgsFIdxonxoff	xonxoff field id
BsSerialReqOpenArgsFIdNumOf	number of fields

Definition at line 45 of file bsSerialMsgs.c.

 {
   BsSerialReqOpenArgsFIdReserved        = 0,    ///< reserved field id
   BsSerialReqOpenArgsFIdbaudrate        = 1,    ///< baudrate field id
   BsSerialReqOpenArgsFIdbytesize        = 2,    ///< bytesize field id
   BsSerialReqOpenArgsFIdparity          = 3,    ///< parity field id
   BsSerialReqOpenArgsFIdstopbits        = 4,    ///< stopbits field id
   BsSerialReqOpenArgsFIdrtscts          = 5,    ///< rtscts field id
   BsSerialReqOpenArgsFIdxonxoff         = 6,    ///< xonxoff field id
   BsSerialReqOpenArgsFIdNumOf           = 7     ///< number of fields
 } BsSerialReqOpenArgsFId_T;

enum BsSerialReqReadFId_T

BsSerialReqRead Field Id Enumeration

Enumerator
BsSerialReqReadFIdReserved	reserved field id
BsSerialReqReadFIdreadlen	readlen field id
BsSerialReqReadFIdNumOf	number of fields

Definition at line 132 of file bsSerialMsgs.c.

 {
   BsSerialReqReadFIdReserved            = 0,    ///< reserved field id
   BsSerialReqReadFIdreadlen             = 1,    ///< readlen field id
   BsSerialReqReadFIdNumOf               = 2     ///< number of fields
 } BsSerialReqReadFId_T;

enum BsSerialReqTransFId_T

BsSerialReqTrans Field Id Enumeration

Enumerator
BsSerialReqTransFIdReserved	reserved field id
BsSerialReqTransFIdwritebuf	writebuf field id
BsSerialReqTransFIdreadlen	readlen field id
BsSerialReqTransFIdNumOf	number of fields

Definition at line 194 of file bsSerialMsgs.c.

 {
   BsSerialReqTransFIdReserved           = 0,    ///< reserved field id
   BsSerialReqTransFIdwritebuf           = 1,    ///< writebuf field id
   BsSerialReqTransFIdreadlen            = 2,    ///< readlen field id
   BsSerialReqTransFIdNumOf              = 3     ///< number of fields
 } BsSerialReqTransFId_T;

enum BsSerialReqWriteFId_T

BsSerialReqWrite Field Id Enumeration

Enumerator
BsSerialReqWriteFIdReserved	reserved field id
BsSerialReqWriteFIdwritebuf	writebuf field id
BsSerialReqWriteFIdNumOf	number of fields

Definition at line 333 of file bsSerialMsgs.c.

 {
   BsSerialReqWriteFIdReserved           = 0,    ///< reserved field id
   BsSerialReqWriteFIdwritebuf           = 1,    ///< writebuf field id
   BsSerialReqWriteFIdNumOf              = 2     ///< number of fields
 } BsSerialReqWriteFId_T;

enum BsSerialRspReadFId_T

BsSerialRspRead Field Id Enumeration

Enumerator
BsSerialRspReadFIdReserved	reserved field id
BsSerialRspReadFIdreadbuf	readbuf field id
BsSerialRspReadFIdNumOf	number of fields

Definition at line 269 of file bsSerialMsgs.c.

 {
   BsSerialRspReadFIdReserved            = 0,    ///< reserved field id
   BsSerialRspReadFIdreadbuf             = 1,    ///< readbuf field id
   BsSerialRspReadFIdNumOf               = 2     ///< number of fields
 } BsSerialRspReadFId_T;

enum BsSerialRspWriteFId_T

BsSerialRspWrite Field Id Enumeration

Enumerator
BsSerialRspWriteFIdReserved	reserved field id
BsSerialRspWriteFIdbyteswritten	byteswritten field id
BsSerialRspWriteFIdNumOf	number of fields

Definition at line 379 of file bsSerialMsgs.c.

 {
   BsSerialRspWriteFIdReserved           = 0,    ///< reserved field id
   BsSerialRspWriteFIdbyteswritten       = 1,    ///< byteswritten field id
   BsSerialRspWriteFIdNumOf              = 2     ///< number of fields
 } BsSerialRspWriteFId_T;

Function Documentation

const NMMsgDef_T* BsSerialLookupMsgDef ( BsSerialMsgId_T eMsgId )

Look up the message definition associated with the message id.

Parameters

eMsgId Message Id.

Returns: On success, returns the pointer to the NMMsgDef_T. On error, NULL is returned.

Definition at line 464 of file bsSerialMsgs.c.

References BsSerialMsgDefLookupTbl, and BsSerialMsgIdNumOf.

Referenced by bsSerialGetMsgName(), BsSerialPackMsg(), and BsSerialUnpackMsg().

 {
   if( (uint_t)eMsgId >= (uint_t)BsSerialMsgIdNumOf )
   {
     return NULL;
   }
   else
   {
     return BsSerialMsgDefLookupTbl[(uint_t)eMsgId];
   }
 }

size_t BsSerialLookupMsgMaxLen ( BsSerialMsgId_T eMsgId )

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.

Parameters

eMsgId Message Id.

Returns: On success, returns the number of bytes. On error, 0 is returned.

Definition at line 488 of file bsSerialMsgs.c.

References BsSerialMsgIdNumOf, and BsSerialMsgMaxLenLookupTbl.

 {
   if( (uint_t)eMsgId >= (uint_t)BsSerialMsgIdNumOf )
   {
     return (size_t)0;
   }
   else
   {
     return BsSerialMsgMaxLenLookupTbl[(uint_t)eMsgId];
   }
 }

int BsSerialPackMsg	(	BsSerialMsgId_T	eMsgId,
		void *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a ITV message in big-endian byte order.

Parameters

	eMsgId	Message Id.
[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 514 of file bsSerialMsgs.c.

References BsSerialLookupMsgDef().

Referenced by BsSerialPackReqOpenArgs(), BsSerialPackReqRead(), BsSerialPackReqTrans(), BsSerialPackReqWrite(), BsSerialPackRspRead(), and BsSerialPackRspWrite().

 {
   const  NMMsgDef_T  *pMsgDef;
   
   if( (pMsgDef = BsSerialLookupMsgDef(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);
   }
 }

int BsSerialUnpackMsg	(	BsSerialMsgId_T	eMsgId,
		byte_t	buf[],
		size_t	uMsgLen,
		void *	pStruct,
		bool_t	bTrace
	)

Unpack a ITV message in big-endian byte order.

Parameters

	eMsgId	Message Id.
[in]	buf	Input message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 552 of file bsSerialMsgs.c.

References BsSerialLookupMsgDef().

Referenced by BsSerialUnpackReqOpenArgs(), BsSerialUnpackReqRead(), BsSerialUnpackReqTrans(), BsSerialUnpackReqWrite(), BsSerialUnpackRspRead(), and BsSerialUnpackRspWrite().

 {
   const  NMMsgDef_T  *pMsgDef;
   
   if( (pMsgDef = BsSerialLookupMsgDef(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);
   }
 }

Variable Documentation

const NMMsgDef_T* BsSerialMsgDefLookupTbl[]

Initial value:

=
{
  NULL,                                 
  &BsSerialReqOpenArgsMsgDef,           
  &BsSerialReqReadMsgDef,               
  &BsSerialReqTransMsgDef,              
  &BsSerialRspReadMsgDef,               
  &BsSerialReqWriteMsgDef,              
  &BsSerialRspWriteMsgDef,              
  NULL                                  
}

BsSerial Message Definition Look-Up Table. Indexed by BsSerialMsgId_T enum.

Definition at line 423 of file bsSerialMsgs.c.

Referenced by BsSerialLookupMsgDef().

size_t BsSerialMsgMaxLenLookupTbl[]

Initial value:

=
{
  (size_t)(0),                          
  (size_t)(24),                         
  (size_t)(6),                          
  (size_t)(265),                        
  (size_t)(262),                        
  (size_t)(262),                        
  (size_t)(6),                          
  (size_t)(0)                           
}

BsSerial Message Maximum Size Look-Up Table. Indexed by BsSerialMsgId_T enum.

Definition at line 438 of file bsSerialMsgs.c.

Referenced by BsSerialLookupMsgMaxLen().

const NMFieldDef_T BsSerialReqOpenArgsFieldDefs[]

static

BsSerialReqOpenArgs Field Definitions

Definition at line 60 of file bsSerialMsgs.c.

const NMMsgDef_T BsSerialReqOpenArgsMsgDef

static

Initial value:

=
{
  .m_sMsgName         = "BsSerialReqOpenArgs",
  .m_eMsgId           = BsSerialMsgIdReqOpenArgs,
  .m_uCount           = (size_t)(6),
  .m_pFields          = BsSerialReqOpenArgsFieldDefs
}

BsSerialReqOpenArgs Message Definition

Definition at line 116 of file bsSerialMsgs.c.

const NMFieldDef_T BsSerialReqReadFieldDefs[]

static

Initial value:

=
{
  {
    .m_sFName                 = "readlen",
    .m_eFId                   = BsSerialReqReadFIdreadlen,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsSerialReqRead_T, m_readlen),
    .m_this.m_u8.m_bits       = (byte_t)(NMBITS_HAS_MIN|NMBITS_HAS_MAX),
    .m_this.m_u8.m_valMin     = (byte_t)(1),
    .m_this.m_u8.m_valMax     = (byte_t)(NMFVAL_LEN_MAX_VECTOR),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
   {NULL, 0, NMFTypeNone, 0, } 
}

BsSerialReqRead Field Definitions

Definition at line 142 of file bsSerialMsgs.c.

const NMMsgDef_T BsSerialReqReadMsgDef

static

Initial value:

=
{
  .m_sMsgName         = "BsSerialReqRead",
  .m_eMsgId           = BsSerialMsgIdReqRead,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsSerialReqReadFieldDefs
}

BsSerialReqRead Message Definition

Definition at line 160 of file bsSerialMsgs.c.

const NMFieldDef_T BsSerialReqTransFieldDefs[]

static

Initial value:

=
{
  {
    .m_sFName                 = "writebuf",
    .m_eFId                   = BsSerialReqTransFIdwritebuf,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsSerialReqTrans_T, m_writebuf),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSSERIAL_REQTRANS_WRITEBUF_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsSerialReqTranswritebufFieldDef,
  },
  {
    .m_sFName                 = "readlen",
    .m_eFId                   = BsSerialReqTransFIdreadlen,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsSerialReqTrans_T, m_readlen),
    .m_this.m_u8.m_bits       = (byte_t)(NMBITS_HAS_MIN|NMBITS_HAS_MAX),
    .m_this.m_u8.m_valMin     = (byte_t)(1),
    .m_this.m_u8.m_valMax     = (byte_t)(NMFVAL_LEN_MAX_VECTOR),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
   {NULL, 0, NMFTypeNone, 0, } 
}

BsSerialReqTrans Field Definitions

Definition at line 205 of file bsSerialMsgs.c.

const NMMsgDef_T BsSerialReqTransMsgDef

static

Initial value:

=
{
  .m_sMsgName         = "BsSerialReqTrans",
  .m_eMsgId           = BsSerialMsgIdReqTrans,
  .m_uCount           = (size_t)(2),
  .m_pFields          = BsSerialReqTransFieldDefs
}

BsSerialReqTrans Message Definition

Definition at line 235 of file bsSerialMsgs.c.

const NMFieldDef_T BsSerialReqTranswritebufFieldDef[]

static

Initial value:

=
{
  {
    .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),
  },
   {NULL, 0, NMFTypeNone, 0, } 
}

BsSerialReqTranswritebuf Field Definitions

Definition at line 176 of file bsSerialMsgs.c.

const NMFieldDef_T BsSerialReqWriteFieldDefs[]

static

Initial value:

=
{
  {
    .m_sFName                 = "writebuf",
    .m_eFId                   = BsSerialReqWriteFIdwritebuf,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsSerialReqWrite_T, m_writebuf),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSSERIAL_REQWRITE_WRITEBUF_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsSerialReqWritewritebufFieldDef,
  },
   {NULL, 0, NMFTypeNone, 0, } 
}

BsSerialReqWrite Field Definitions

Definition at line 343 of file bsSerialMsgs.c.

const NMMsgDef_T BsSerialReqWriteMsgDef

static

Initial value:

=
{
  .m_sMsgName         = "BsSerialReqWrite",
  .m_eMsgId           = BsSerialMsgIdReqWrite,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsSerialReqWriteFieldDefs
}

BsSerialReqWrite Message Definition

Definition at line 363 of file bsSerialMsgs.c.

const NMFieldDef_T BsSerialReqWritewritebufFieldDef[]

static

Initial value:

=
{
  {
    .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),
  },
   {NULL, 0, NMFTypeNone, 0, } 
}

BsSerialReqWritewritebuf Field Definitions

Definition at line 315 of file bsSerialMsgs.c.

const NMFieldDef_T BsSerialRspReadFieldDefs[]

static

Initial value:

=
{
  {
    .m_sFName                 = "readbuf",
    .m_eFId                   = BsSerialRspReadFIdreadbuf,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsSerialRspRead_T, m_readbuf),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSSERIAL_RSPREAD_READBUF_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsSerialRspReadreadbufFieldDef,
  },
   {NULL, 0, NMFTypeNone, 0, } 
}

BsSerialRspRead Field Definitions

Definition at line 279 of file bsSerialMsgs.c.

const NMMsgDef_T BsSerialRspReadMsgDef

static

Initial value:

=
{
  .m_sMsgName         = "BsSerialRspRead",
  .m_eMsgId           = BsSerialMsgIdRspRead,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsSerialRspReadFieldDefs
}

BsSerialRspRead Message Definition

Definition at line 299 of file bsSerialMsgs.c.

const NMFieldDef_T BsSerialRspReadreadbufFieldDef[]

static

Initial value:

=
{
  {
    .m_sFName                 = "readbuf",
    .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),
  },
   {NULL, 0, NMFTypeNone, 0, } 
}

BsSerialRspReadreadbuf Field Definitions

Definition at line 251 of file bsSerialMsgs.c.

const NMFieldDef_T BsSerialRspWriteFieldDefs[]

static

Initial value:

=
{
  {
    .m_sFName                 = "byteswritten",
    .m_eFId                   = BsSerialRspWriteFIdbyteswritten,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsSerialRspWrite_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),
  },
   {NULL, 0, NMFTypeNone, 0, } 
}

BsSerialRspWrite Field Definitions

Definition at line 389 of file bsSerialMsgs.c.

const NMMsgDef_T BsSerialRspWriteMsgDef

static

Initial value:

=
{
  .m_sMsgName         = "BsSerialRspWrite",
  .m_eMsgId           = BsSerialMsgIdRspWrite,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsSerialRspWriteFieldDefs
}

BsSerialRspWrite Message Definition

Definition at line 407 of file bsSerialMsgs.c.

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation