BotSense bsProxy server - client /dev/null NetMsgs XML Definition. More...

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

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

Enumerations
enum	BsNullReqWriteFId_T { BsNullReqWriteFIdReserved = 0, BsNullReqWriteFIdwritebuf = 1, BsNullReqWriteFIdNumOf = 2 }

enum	BsNullRspWriteFId_T { BsNullRspWriteFIdReserved = 0, BsNullRspWriteFIdbyteswritten = 1, BsNullRspWriteFIdNumOf = 2 }

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

size_t	BsNullLookupMsgMaxLen (BsNullMsgId_T eMsgId)
	Look up the message maximum length associated with the message id. More...

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

int	BsNullUnpackMsg (BsNullMsgId_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	BsNullReqWritewritebufFieldDef []

static const NMFieldDef_T	BsNullReqWriteFieldDefs []

static const NMMsgDef_T	BsNullReqWriteMsgDef

static const NMFieldDef_T	BsNullRspWriteFieldDefs []

static const NMMsgDef_T	BsNullRspWriteMsgDef

const NMMsgDef_T *	BsNullMsgDefLookupTbl []

size_t	BsNullMsgMaxLenLookupTbl []

Detailed Description

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.

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

Definition in file bsNullMsgs.c.

Macro Definition Documentation

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

End of Field Definition entry.

Definition at line 29 of file bsNullMsgs.c.

Enumeration Type Documentation

enum BsNullReqWriteFId_T

BsNullReqWrite Field Id Enumeration

Enumerator
BsNullReqWriteFIdReserved	reserved field id
BsNullReqWriteFIdwritebuf	writebuf field id
BsNullReqWriteFIdNumOf	number of fields

Definition at line 63 of file bsNullMsgs.c.

 {
   BsNullReqWriteFIdReserved             = 0,    ///< reserved field id
   BsNullReqWriteFIdwritebuf             = 1,    ///< writebuf field id
   BsNullReqWriteFIdNumOf                = 2     ///< number of fields
 } BsNullReqWriteFId_T;

enum BsNullRspWriteFId_T

BsNullRspWrite Field Id Enumeration

Enumerator
BsNullRspWriteFIdReserved	reserved field id
BsNullRspWriteFIdbyteswritten	byteswritten field id
BsNullRspWriteFIdNumOf	number of fields

Definition at line 109 of file bsNullMsgs.c.

 {
   BsNullRspWriteFIdReserved             = 0,    ///< reserved field id
   BsNullRspWriteFIdbyteswritten         = 1,    ///< byteswritten field id
   BsNullRspWriteFIdNumOf                = 2     ///< number of fields
 } BsNullRspWriteFId_T;

Function Documentation

const NMMsgDef_T* BsNullLookupMsgDef ( BsNullMsgId_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 186 of file bsNullMsgs.c.

References BsNullMsgDefLookupTbl, and BsNullMsgIdNumOf.

Referenced by bsNullGetMsgName(), BsNullPackMsg(), and BsNullUnpackMsg().

 {
   if( (uint_t)eMsgId >= (uint_t)BsNullMsgIdNumOf )
   {
     return NULL;
   }
   else
   {
     return BsNullMsgDefLookupTbl[(uint_t)eMsgId];
   }
 }

size_t BsNullLookupMsgMaxLen ( BsNullMsgId_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 210 of file bsNullMsgs.c.

References BsNullMsgIdNumOf, and BsNullMsgMaxLenLookupTbl.

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

int BsNullPackMsg	(	BsNullMsgId_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 236 of file bsNullMsgs.c.

References BsNullLookupMsgDef().

Referenced by BsNullPackReqWrite(), and BsNullPackRspWrite().

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

int BsNullUnpackMsg	(	BsNullMsgId_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 274 of file bsNullMsgs.c.

References BsNullLookupMsgDef().

Referenced by BsNullUnpackReqWrite(), and BsNullUnpackRspWrite().

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

Variable Documentation

const NMMsgDef_T* BsNullMsgDefLookupTbl[]

Initial value:

=
{
  NULL,                                 
  &BsNullReqWriteMsgDef,                
  &BsNullRspWriteMsgDef,                
  NULL                                  
}

BsNull Message Definition Look-Up Table. Indexed by BsNullMsgId_T enum.

Definition at line 153 of file bsNullMsgs.c.

Referenced by BsNullLookupMsgDef().

size_t BsNullMsgMaxLenLookupTbl[]

Initial value:

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

BsNull Message Maximum Size Look-Up Table. Indexed by BsNullMsgId_T enum.

Definition at line 164 of file bsNullMsgs.c.

Referenced by BsNullLookupMsgMaxLen().

const NMFieldDef_T BsNullReqWriteFieldDefs[]

static

Initial value:

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

BsNullReqWrite Field Definitions

Definition at line 73 of file bsNullMsgs.c.

const NMMsgDef_T BsNullReqWriteMsgDef

static

Initial value:

=
{
  .m_sMsgName         = "BsNullReqWrite",
  .m_eMsgId           = BsNullMsgIdReqWrite,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsNullReqWriteFieldDefs
}

BsNullReqWrite Message Definition

Definition at line 93 of file bsNullMsgs.c.

const NMFieldDef_T BsNullReqWritewritebufFieldDef[]

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

BsNullReqWritewritebuf Field Definitions

Definition at line 45 of file bsNullMsgs.c.

const NMFieldDef_T BsNullRspWriteFieldDefs[]

static

Initial value:

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

BsNullRspWrite Field Definitions

Definition at line 119 of file bsNullMsgs.c.

const NMMsgDef_T BsNullRspWriteMsgDef

static

Initial value:

=
{
  .m_sMsgName         = "BsNullRspWrite",
  .m_eMsgId           = BsNullMsgIdRspWrite,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsNullRspWriteFieldDefs
}

BsNullRspWrite Message Definition

Definition at line 137 of file bsNullMsgs.c.

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation