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

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

Classes
struct	BsNullReqWrite_T

struct	BsNullRspWrite_T

Macros
#define	BSNULL_REQWRITE_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

Enumerations
enum	BsNullMsgId_T { BsNullMsgIdNone = 0, BsNullMsgIdReqWrite = 1, BsNullMsgIdRspWrite = 2, BsNullMsgIdNumOf = 3 }

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

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

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

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

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

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

Macro Definition Documentation

#define BSNULL_REQWRITE_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

ReqWrite writebuf maximum vector length

Definition at line 54 of file bsNullMsgs.h.

Referenced by bsNullReqWrite().

Enumeration Type Documentation

enum BsNullMsgId_T

BsNull Message Id Enumeration

Enumerator
BsNullMsgIdNone	no message
BsNullMsgIdReqWrite	ReqWrite.
BsNullMsgIdRspWrite	RspWrite.
BsNullMsgIdNumOf	number of message ids

Definition at line 35 of file bsNullMsgs.h.

 {
   BsNullMsgIdNone                       = 0,    ///< no message
   BsNullMsgIdReqWrite                   = 1,    ///< ReqWrite
   BsNullMsgIdRspWrite                   = 2,    ///< RspWrite
   BsNullMsgIdNumOf                      = 3     ///< number of message ids
 } BsNullMsgId_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);
   }
 }

INLINE_IN_H int BsNullPackReqWrite	(	BsNullReqWrite_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsNullReqWrite 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 138 of file bsNullMsgs.h.

References BsNullMsgIdReqWrite, and BsNullPackMsg().

Referenced by bsNullReqWrite().

 {
   return BsNullPackMsg(BsNullMsgIdReqWrite, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsNullPackRspWrite	(	BsNullRspWrite_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsNullRspWrite 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 181 of file bsNullMsgs.h.

References BsNullMsgIdRspWrite, and BsNullPackMsg().

Referenced by bsModNullReqWrite().

 {
   return BsNullPackMsg(BsNullMsgIdRspWrite, pStruct, buf, bufSize, bTrace);
 }

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

INLINE_IN_H int BsNullUnpackReqWrite	(	byte_t	buf[],
		size_t	uMsgLen,
		BsNullReqWrite_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsNullReqWrite 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 159 of file bsNullMsgs.h.

References BsNullMsgIdReqWrite, and BsNullUnpackMsg().

Referenced by bsModNullReqWrite().

 {
   return BsNullUnpackMsg(BsNullMsgIdReqWrite, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsNullUnpackRspWrite	(	byte_t	buf[],
		size_t	uMsgLen,
		BsNullRspWrite_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsNullRspWrite 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 202 of file bsNullMsgs.h.

References BsNullMsgIdRspWrite, and BsNullUnpackMsg().

Referenced by bsNullReqWrite().

 {
   return BsNullUnpackMsg(BsNullMsgIdRspWrite, buf, uMsgLen, pStruct, bTrace);
 }

Variable Documentation

const NMMsgDef_T* BsNullMsgDefLookupTbl[]

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

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

Definition at line 164 of file bsNullMsgs.c.

Referenced by BsNullLookupMsgMaxLen().

Classes

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation