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

#include "rnr/rnrconfig.h"
#include "rnr/netmsgs.h"
#include "botsense/BotSense.h"

Classes
struct	BsSerialReqOpenArgs_T

struct	BsSerialReqRead_T

struct	BsSerialReqTrans_T

struct	BsSerialRspRead_T

struct	BsSerialReqWrite_T

struct	BsSerialRspWrite_T

Macros
#define	BSSERIAL_REQTRANS_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

#define	BSSERIAL_RSPREAD_READBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

#define	BSSERIAL_REQWRITE_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

Enumerations
enum	BsSerialMsgId_T { BsSerialMsgIdNone = 0, BsSerialMsgIdReqOpenArgs = 1, BsSerialMsgIdReqRead = 2, BsSerialMsgIdReqTrans = 3, BsSerialMsgIdRspRead = 4, BsSerialMsgIdReqWrite = 5, BsSerialMsgIdRspWrite = 6, BsSerialMsgIdNumOf = 7 }

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

INLINE_IN_H int	BsSerialPackReqOpenArgs (BsSerialReqOpenArgs_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsSerialReqOpenArgs ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsSerialUnpackReqOpenArgs (byte_t buf[], size_t uMsgLen, BsSerialReqOpenArgs_T *pStruct, bool_t bTrace)
	Unpack a BsSerialReqOpenArgs ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsSerialPackReqRead (BsSerialReqRead_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsSerialReqRead ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsSerialUnpackReqRead (byte_t buf[], size_t uMsgLen, BsSerialReqRead_T *pStruct, bool_t bTrace)
	Unpack a BsSerialReqRead ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsSerialPackReqTrans (BsSerialReqTrans_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsSerialReqTrans ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsSerialUnpackReqTrans (byte_t buf[], size_t uMsgLen, BsSerialReqTrans_T *pStruct, bool_t bTrace)
	Unpack a BsSerialReqTrans ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsSerialPackRspRead (BsSerialRspRead_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsSerialRspRead ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsSerialUnpackRspRead (byte_t buf[], size_t uMsgLen, BsSerialRspRead_T *pStruct, bool_t bTrace)
	Unpack a BsSerialRspRead ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsSerialPackReqWrite (BsSerialReqWrite_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsSerialReqWrite ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsSerialUnpackReqWrite (byte_t buf[], size_t uMsgLen, BsSerialReqWrite_T *pStruct, bool_t bTrace)
	Unpack a BsSerialReqWrite ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsSerialPackRspWrite (BsSerialRspWrite_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsSerialRspWrite ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsSerialUnpackRspWrite (byte_t buf[], size_t uMsgLen, BsSerialRspWrite_T *pStruct, bool_t bTrace)
	Unpack a BsSerialRspWrite ITV message in big-endian byte order from the input buffer. More...

Variables
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.h.

Macro Definition Documentation

#define BSSERIAL_REQTRANS_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

ReqTrans writebuf maximum vector length

Definition at line 89 of file bsSerialMsgs.h.

Referenced by bsSerialReqTrans().

#define BSSERIAL_REQWRITE_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

ReqWrite writebuf maximum vector length

Definition at line 140 of file bsSerialMsgs.h.

Referenced by bsSerialReqWrite().

#define BSSERIAL_RSPREAD_READBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

RspRead readbuf maximum vector length

Definition at line 115 of file bsSerialMsgs.h.

Referenced by bsSerialReqRead(), and bsSerialReqTrans().

Enumeration Type Documentation

enum BsSerialMsgId_T

BsSerial Message Id Enumeration

Enumerator
BsSerialMsgIdNone	no message
BsSerialMsgIdReqOpenArgs	ReqOpenArgs.
BsSerialMsgIdReqRead	ReqRead.
BsSerialMsgIdReqTrans	ReqTrans.
BsSerialMsgIdRspRead	RspRead.
BsSerialMsgIdReqWrite	ReqWrite.
BsSerialMsgIdRspWrite	RspWrite.
BsSerialMsgIdNumOf	number of message ids

Definition at line 35 of file bsSerialMsgs.h.

 {
   BsSerialMsgIdNone                     = 0,    ///< no message
   BsSerialMsgIdReqOpenArgs              = 1,    ///< ReqOpenArgs
   BsSerialMsgIdReqRead                  = 2,    ///< ReqRead
   BsSerialMsgIdReqTrans                 = 3,    ///< ReqTrans
   BsSerialMsgIdRspRead                  = 4,    ///< RspRead
   BsSerialMsgIdReqWrite                 = 5,    ///< ReqWrite
   BsSerialMsgIdRspWrite                 = 6,    ///< RspWrite
   BsSerialMsgIdNumOf                    = 7     ///< number of message ids
 } BsSerialMsgId_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);
   }
 }

INLINE_IN_H int BsSerialPackReqOpenArgs	(	BsSerialReqOpenArgs_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsSerialReqOpenArgs ITV message in big-endian byte order into the output buffer.

Parameters

[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 224 of file bsSerialMsgs.h.

References BsSerialMsgIdReqOpenArgs, and BsSerialPackMsg().

Referenced by bsSerialReqOpen().

 {
   return BsSerialPackMsg(BsSerialMsgIdReqOpenArgs, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsSerialPackReqRead	(	BsSerialReqRead_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsSerialReqRead ITV message in big-endian byte order into the output buffer.

Parameters

[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 267 of file bsSerialMsgs.h.

References BsSerialMsgIdReqRead, and BsSerialPackMsg().

Referenced by bsSerialReqRead().

 {
   return BsSerialPackMsg(BsSerialMsgIdReqRead, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsSerialPackReqTrans	(	BsSerialReqTrans_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsSerialReqTrans ITV message in big-endian byte order into the output buffer.

Parameters

[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 310 of file bsSerialMsgs.h.

References BsSerialMsgIdReqTrans, and BsSerialPackMsg().

Referenced by bsSerialReqTrans().

 {
   return BsSerialPackMsg(BsSerialMsgIdReqTrans, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsSerialPackReqWrite	(	BsSerialReqWrite_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsSerialReqWrite ITV message in big-endian byte order into the output buffer.

Parameters

[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 396 of file bsSerialMsgs.h.

References BsSerialMsgIdReqWrite, and BsSerialPackMsg().

Referenced by bsSerialReqWrite().

 {
   return BsSerialPackMsg(BsSerialMsgIdReqWrite, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsSerialPackRspRead	(	BsSerialRspRead_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsSerialRspRead ITV message in big-endian byte order into the output buffer.

Parameters

[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 353 of file bsSerialMsgs.h.

References BsSerialMsgIdRspRead, and BsSerialPackMsg().

Referenced by bsModSerialReqRead(), and bsModSerialReqTrans().

 {
   return BsSerialPackMsg(BsSerialMsgIdRspRead, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsSerialPackRspWrite	(	BsSerialRspWrite_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsSerialRspWrite ITV message in big-endian byte order into the output buffer.

Parameters

[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 439 of file bsSerialMsgs.h.

References BsSerialMsgIdRspWrite, and BsSerialPackMsg().

Referenced by bsModSerialReqWrite().

 {
   return BsSerialPackMsg(BsSerialMsgIdRspWrite, pStruct, buf, bufSize, bTrace);
 }

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

INLINE_IN_H int BsSerialUnpackReqOpenArgs	(	byte_t	buf[],
		size_t	uMsgLen,
		BsSerialReqOpenArgs_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsSerialReqOpenArgs ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output 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 245 of file bsSerialMsgs.h.

References BsSerialMsgIdReqOpenArgs, and BsSerialUnpackMsg().

Referenced by bsModOpen().

 {
   return BsSerialUnpackMsg(BsSerialMsgIdReqOpenArgs, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsSerialUnpackReqRead	(	byte_t	buf[],
		size_t	uMsgLen,
		BsSerialReqRead_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsSerialReqRead ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output 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 288 of file bsSerialMsgs.h.

References BsSerialMsgIdReqRead, and BsSerialUnpackMsg().

Referenced by bsModSerialReqRead().

 {
   return BsSerialUnpackMsg(BsSerialMsgIdReqRead, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsSerialUnpackReqTrans	(	byte_t	buf[],
		size_t	uMsgLen,
		BsSerialReqTrans_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsSerialReqTrans ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output 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 331 of file bsSerialMsgs.h.

References BsSerialMsgIdReqTrans, and BsSerialUnpackMsg().

Referenced by bsModSerialReqTrans().

 {
   return BsSerialUnpackMsg(BsSerialMsgIdReqTrans, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsSerialUnpackReqWrite	(	byte_t	buf[],
		size_t	uMsgLen,
		BsSerialReqWrite_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsSerialReqWrite ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output 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 417 of file bsSerialMsgs.h.

References BsSerialMsgIdReqWrite, and BsSerialUnpackMsg().

Referenced by bsModSerialReqWrite().

 {
   return BsSerialUnpackMsg(BsSerialMsgIdReqWrite, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsSerialUnpackRspRead	(	byte_t	buf[],
		size_t	uMsgLen,
		BsSerialRspRead_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsSerialRspRead ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output 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 374 of file bsSerialMsgs.h.

References BsSerialMsgIdRspRead, and BsSerialUnpackMsg().

Referenced by bsSerialReqRead(), and bsSerialReqTrans().

 {
   return BsSerialUnpackMsg(BsSerialMsgIdRspRead, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsSerialUnpackRspWrite	(	byte_t	buf[],
		size_t	uMsgLen,
		BsSerialRspWrite_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsSerialRspWrite ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output 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 460 of file bsSerialMsgs.h.

References BsSerialMsgIdRspWrite, and BsSerialUnpackMsg().

Referenced by bsSerialReqWrite().

 {
   return BsSerialUnpackMsg(BsSerialMsgIdRspWrite, buf, uMsgLen, pStruct, bTrace);
 }

Variable Documentation

const NMMsgDef_T* BsSerialMsgDefLookupTbl[]

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[]

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

Definition at line 438 of file bsSerialMsgs.c.

Referenced by BsSerialLookupMsgMaxLen().

Classes

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation