BotSense client application - bsProxy server-terminated core messages. More...

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

Classes
struct	BsProxyRspErr_T

struct	BsProxyReqLoopback_T

struct	BsProxyRspLoopback_T

struct	BsProxyReqSetLogging_T

struct	BsProxyRspGetVersion_T

struct	BsProxyReqMsgTrace_T

struct	BsProxyReqDevOpen_T

struct	BsProxyRspDevOpen_T

struct	BsProxyReqDevClose_T

struct	BsProxyRspGetVConnList_T

struct	BsProxyReqGetVConnInfo_T

struct	BsProxyRspGetVConnInfo_T

Macros
#define	BSPROXY_RSPERR_EMSG_LEN (NMFVAL_LEN_MAX_STRING)

#define	BSPROXY_REQLOOPBACK_CDATA_LEN (NMFVAL_LEN_MAX_STRING)

#define	BSPROXY_RSPLOOPBACK_CDATA_LEN (NMFVAL_LEN_MAX_STRING)

#define	BSPROXY_RSPGETVERSION_VERSION_LEN (NMFVAL_LEN_MAX_STRING)

#define	BSPROXY_REQDEVOPEN_DEVNAME_LEN (NMFVAL_LEN_MAX_STRING)

#define	BSPROXY_REQDEVOPEN_MODNAME_LEN (NMFVAL_LEN_MAX_STRING)

#define	BSPROXY_REQDEVOPEN_ARGBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

#define	BSPROXY_RSPGETVCONNINFO_CLIENT_LEN (NMFVAL_LEN_MAX_STRING)

#define	BSPROXY_RSPGETVCONNINFO_DEVURI_LEN (NMFVAL_LEN_MAX_STRING)

#define	BSPROXY_RSPGETVCONNINFO_MODURI_LEN (NMFVAL_LEN_MAX_STRING)

#define	BSPROXY_RSPGETVCONNINFO_MODVER_LEN (NMFVAL_LEN_MAX_STRING)

#define	BSPROXY_RSPGETVCONNINFO_MODDATE_LEN (NMFVAL_LEN_MAX_STRING)

Enumerations
enum	BsProxyMsgId_T { BsProxyMsgIdNone = 0, BsProxyMsgIdRspOk = 1, BsProxyMsgIdRspErr = 2, BsProxyMsgIdReqLoopback = 3, BsProxyMsgIdRspLoopback = 4, BsProxyMsgIdReqSetLogging = 5, BsProxyMsgIdReqGetVersion = 6, BsProxyMsgIdRspGetVersion = 7, BsProxyMsgIdReqMsgTrace = 8, BsProxyMsgIdReqDevOpen = 9, BsProxyMsgIdRspDevOpen = 10, BsProxyMsgIdReqDevClose = 11, BsProxyMsgIdReqGetVConnList = 12, BsProxyMsgIdRspGetVConnList = 13, BsProxyMsgIdReqGetVConnInfo = 14, BsProxyMsgIdRspGetVConnInfo = 15, BsProxyMsgIdNumOf = 16 }

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

size_t	BsProxyLookupMsgMaxLen (BsProxyMsgId_T eMsgId)
	Look up the message maximum length associated with the message id. More...

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

int	BsProxyUnpackMsg (BsProxyMsgId_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	BsProxyPackRspErr (BsProxyRspErr_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsProxyRspErr ITV message in big-endian byte order into the output buffer. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Variables
const NMMsgDef_T *	BsProxyMsgDefLookupTbl []

size_t	BsProxyMsgMaxLenLookupTbl []

Detailed Description

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.

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

Definition in file bsProxyMsgs.h.

Macro Definition Documentation

#define BSPROXY_REQDEVOPEN_ARGBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

ReqDevOpen argbuf maximum vector length

Definition at line 169 of file bsProxyMsgs.h.

Referenced by bsServerReqOpenDev().

#define BSPROXY_REQDEVOPEN_DEVNAME_LEN (NMFVAL_LEN_MAX_STRING)

ReqDevOpen devname maximum string length

Definition at line 163 of file bsProxyMsgs.h.

Referenced by bsServerReqOpenDev().

#define BSPROXY_REQDEVOPEN_MODNAME_LEN (NMFVAL_LEN_MAX_STRING)

ReqDevOpen modname maximum string length

Definition at line 166 of file bsProxyMsgs.h.

Referenced by bsServerReqOpenDev().

#define BSPROXY_REQLOOPBACK_CDATA_LEN (NMFVAL_LEN_MAX_STRING)

ReqLoopback cdata maximum string length

Definition at line 85 of file bsProxyMsgs.h.

Referenced by ReqLoopback().

#define BSPROXY_RSPERR_EMSG_LEN (NMFVAL_LEN_MAX_STRING)

RspErr emsg maximum string length

Definition at line 67 of file bsProxyMsgs.h.

Referenced by ClientSendVErrorRsp().

#define BSPROXY_RSPGETVCONNINFO_CLIENT_LEN (NMFVAL_LEN_MAX_STRING)

RspGetVConnInfo client maximum string length

Definition at line 260 of file bsProxyMsgs.h.

Referenced by ReqGetVConnInfo().

#define BSPROXY_RSPGETVCONNINFO_DEVURI_LEN (NMFVAL_LEN_MAX_STRING)

RspGetVConnInfo devuri maximum string length

Definition at line 263 of file bsProxyMsgs.h.

Referenced by ReqGetVConnInfo().

#define BSPROXY_RSPGETVCONNINFO_MODDATE_LEN (NMFVAL_LEN_MAX_STRING)

RspGetVConnInfo moddate maximum string length

Definition at line 272 of file bsProxyMsgs.h.

Referenced by ReqGetVConnInfo().

#define BSPROXY_RSPGETVCONNINFO_MODURI_LEN (NMFVAL_LEN_MAX_STRING)

RspGetVConnInfo moduri maximum string length

Definition at line 266 of file bsProxyMsgs.h.

Referenced by ReqGetVConnInfo().

#define BSPROXY_RSPGETVCONNINFO_MODVER_LEN (NMFVAL_LEN_MAX_STRING)

RspGetVConnInfo modver maximum string length

Definition at line 269 of file bsProxyMsgs.h.

Referenced by ReqGetVConnInfo().

#define BSPROXY_RSPGETVERSION_VERSION_LEN (NMFVAL_LEN_MAX_STRING)

RspGetVersion version maximum string length

Definition at line 132 of file bsProxyMsgs.h.

Referenced by ReqGetVersion().

#define BSPROXY_RSPLOOPBACK_CDATA_LEN (NMFVAL_LEN_MAX_STRING)

RspLoopback cdata maximum string length

Definition at line 102 of file bsProxyMsgs.h.

Referenced by ReqLoopback().

Enumeration Type Documentation

enum BsProxyMsgId_T

BsProxy Message Id Enumeration

Enumerator
BsProxyMsgIdNone	no message
BsProxyMsgIdRspOk	RspOk.
BsProxyMsgIdRspErr	RspErr.
BsProxyMsgIdReqLoopback	ReqLoopback.
BsProxyMsgIdRspLoopback	RspLoopback.
BsProxyMsgIdReqSetLogging	ReqSetLogging.
BsProxyMsgIdReqGetVersion	ReqGetVersion.
BsProxyMsgIdRspGetVersion	RspGetVersion.
BsProxyMsgIdReqMsgTrace	ReqMsgTrace.
BsProxyMsgIdReqDevOpen	ReqDevOpen.
BsProxyMsgIdRspDevOpen	RspDevOpen.
BsProxyMsgIdReqDevClose	ReqDevClose.
BsProxyMsgIdReqGetVConnList	ReqGetVConnList.
BsProxyMsgIdRspGetVConnList	RspGetVConnList.
BsProxyMsgIdReqGetVConnInfo	ReqGetVConnInfo.
BsProxyMsgIdRspGetVConnInfo	RspGetVConnInfo.
BsProxyMsgIdNumOf	number of message ids

Definition at line 35 of file bsProxyMsgs.h.

 {
   BsProxyMsgIdNone                      = 0,    ///< no message
   BsProxyMsgIdRspOk                     = 1,    ///< RspOk
   BsProxyMsgIdRspErr                    = 2,    ///< RspErr
   BsProxyMsgIdReqLoopback               = 3,    ///< ReqLoopback
   BsProxyMsgIdRspLoopback               = 4,    ///< RspLoopback
   BsProxyMsgIdReqSetLogging             = 5,    ///< ReqSetLogging
   BsProxyMsgIdReqGetVersion             = 6,    ///< ReqGetVersion
   BsProxyMsgIdRspGetVersion             = 7,    ///< RspGetVersion
   BsProxyMsgIdReqMsgTrace               = 8,    ///< ReqMsgTrace
   BsProxyMsgIdReqDevOpen                = 9,    ///< ReqDevOpen
   BsProxyMsgIdRspDevOpen                = 10,   ///< RspDevOpen
   BsProxyMsgIdReqDevClose               = 11,   ///< ReqDevClose
   BsProxyMsgIdReqGetVConnList           = 12,   ///< ReqGetVConnList
   BsProxyMsgIdRspGetVConnList           = 13,   ///< RspGetVConnList
   BsProxyMsgIdReqGetVConnInfo           = 14,   ///< ReqGetVConnInfo
   BsProxyMsgIdRspGetVConnInfo           = 15,   ///< RspGetVConnInfo
   BsProxyMsgIdNumOf                     = 16    ///< number of message ids
 } BsProxyMsgId_T;

Function Documentation

const NMMsgDef_T* BsProxyLookupMsgDef ( BsProxyMsgId_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 874 of file bsProxyMsgs.c.

References BsProxyMsgDefLookupTbl, and BsProxyMsgIdNumOf.

Referenced by bsClientGetMsgName(), BsProxyLogMsgHdr(), BsProxyPackMsg(), BsProxyUnpackMsg(), and ClientSendServerRsp().

 {
   if( (uint_t)eMsgId >= (uint_t)BsProxyMsgIdNumOf )
   {
     return NULL;
   }
   else
   {
     return BsProxyMsgDefLookupTbl[(uint_t)eMsgId];
   }
 }

size_t BsProxyLookupMsgMaxLen ( BsProxyMsgId_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 898 of file bsProxyMsgs.c.

References BsProxyMsgIdNumOf, and BsProxyMsgMaxLenLookupTbl.

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

int BsProxyPackMsg	(	BsProxyMsgId_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 924 of file bsProxyMsgs.c.

References BsProxyLookupMsgDef().

Referenced by BsProxyPackReqDevClose(), BsProxyPackReqDevOpen(), BsProxyPackReqGetVConnInfo(), BsProxyPackReqLoopback(), BsProxyPackReqMsgTrace(), BsProxyPackReqSetLogging(), BsProxyPackRspDevOpen(), BsProxyPackRspErr(), BsProxyPackRspGetVConnInfo(), BsProxyPackRspGetVConnList(), BsProxyPackRspGetVersion(), BsProxyPackRspLoopback(), and ClientSendServerRsp().

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

INLINE_IN_H int BsProxyPackReqDevClose	(	BsProxyReqDevClose_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyReqDevClose 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 689 of file bsProxyMsgs.h.

References BsProxyMsgIdReqDevClose, and BsProxyPackMsg().

Referenced by bsServerReqCloseDev().

 {
   return BsProxyPackMsg(BsProxyMsgIdReqDevClose, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsProxyPackReqDevOpen	(	BsProxyReqDevOpen_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyReqDevOpen 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 603 of file bsProxyMsgs.h.

References BsProxyMsgIdReqDevOpen, and BsProxyPackMsg().

Referenced by bsServerReqOpenDev().

 {
   return BsProxyPackMsg(BsProxyMsgIdReqDevOpen, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsProxyPackReqGetVConnInfo	(	BsProxyReqGetVConnInfo_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyReqGetVConnInfo 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 775 of file bsProxyMsgs.h.

References BsProxyMsgIdReqGetVConnInfo, and BsProxyPackMsg().

Referenced by bsServerReqGetVConnInfo().

 {
   return BsProxyPackMsg(BsProxyMsgIdReqGetVConnInfo, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsProxyPackReqLoopback	(	BsProxyReqLoopback_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyReqLoopback 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 388 of file bsProxyMsgs.h.

References BsProxyMsgIdReqLoopback, and BsProxyPackMsg().

Referenced by bsServerReqLoopback().

 {
   return BsProxyPackMsg(BsProxyMsgIdReqLoopback, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsProxyPackReqMsgTrace	(	BsProxyReqMsgTrace_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyReqMsgTrace 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 560 of file bsProxyMsgs.h.

References BsProxyMsgIdReqMsgTrace, and BsProxyPackMsg().

Referenced by bsServerReqMsgTrace().

 {
   return BsProxyPackMsg(BsProxyMsgIdReqMsgTrace, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsProxyPackReqSetLogging	(	BsProxyReqSetLogging_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyReqSetLogging 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 474 of file bsProxyMsgs.h.

References BsProxyMsgIdReqSetLogging, and BsProxyPackMsg().

Referenced by bsServerReqSetLogging().

 {
   return BsProxyPackMsg(BsProxyMsgIdReqSetLogging, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsProxyPackRspDevOpen	(	BsProxyRspDevOpen_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyRspDevOpen 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 646 of file bsProxyMsgs.h.

References BsProxyMsgIdRspDevOpen, and BsProxyPackMsg().

 {
   return BsProxyPackMsg(BsProxyMsgIdRspDevOpen, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsProxyPackRspErr	(	BsProxyRspErr_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyRspErr 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 345 of file bsProxyMsgs.h.

References BsProxyMsgIdRspErr, and BsProxyPackMsg().

 {
   return BsProxyPackMsg(BsProxyMsgIdRspErr, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsProxyPackRspGetVConnInfo	(	BsProxyRspGetVConnInfo_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyRspGetVConnInfo 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 818 of file bsProxyMsgs.h.

References BsProxyMsgIdRspGetVConnInfo, and BsProxyPackMsg().

 {
   return BsProxyPackMsg(BsProxyMsgIdRspGetVConnInfo, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsProxyPackRspGetVConnList	(	BsProxyRspGetVConnList_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyRspGetVConnList 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 732 of file bsProxyMsgs.h.

References BsProxyMsgIdRspGetVConnList, and BsProxyPackMsg().

 {
   return BsProxyPackMsg(BsProxyMsgIdRspGetVConnList, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsProxyPackRspGetVersion	(	BsProxyRspGetVersion_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyRspGetVersion 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 517 of file bsProxyMsgs.h.

References BsProxyMsgIdRspGetVersion, and BsProxyPackMsg().

 {
   return BsProxyPackMsg(BsProxyMsgIdRspGetVersion, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsProxyPackRspLoopback	(	BsProxyRspLoopback_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsProxyRspLoopback 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 431 of file bsProxyMsgs.h.

References BsProxyMsgIdRspLoopback, and BsProxyPackMsg().

 {
   return BsProxyPackMsg(BsProxyMsgIdRspLoopback, pStruct, buf, bufSize, bTrace);
 }

int BsProxyUnpackMsg	(	BsProxyMsgId_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 962 of file bsProxyMsgs.c.

References BsProxyLookupMsgDef().

Referenced by BsProxyUnpackReqDevClose(), BsProxyUnpackReqDevOpen(), BsProxyUnpackReqGetVConnInfo(), BsProxyUnpackReqLoopback(), BsProxyUnpackReqMsgTrace(), BsProxyUnpackReqSetLogging(), BsProxyUnpackRspDevOpen(), BsProxyUnpackRspErr(), BsProxyUnpackRspGetVConnInfo(), BsProxyUnpackRspGetVConnList(), BsProxyUnpackRspGetVersion(), and BsProxyUnpackRspLoopback().

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

INLINE_IN_H int BsProxyUnpackReqDevClose	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyReqDevClose_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyReqDevClose 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 710 of file bsProxyMsgs.h.

References BsProxyMsgIdReqDevClose, and BsProxyUnpackMsg().

Referenced by ReqDevClose().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdReqDevClose, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsProxyUnpackReqDevOpen	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyReqDevOpen_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyReqDevOpen 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 624 of file bsProxyMsgs.h.

References BsProxyMsgIdReqDevOpen, and BsProxyUnpackMsg().

Referenced by ReqDevOpen().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdReqDevOpen, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsProxyUnpackReqGetVConnInfo	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyReqGetVConnInfo_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyReqGetVConnInfo 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 796 of file bsProxyMsgs.h.

References BsProxyMsgIdReqGetVConnInfo, and BsProxyUnpackMsg().

Referenced by ReqGetVConnInfo().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdReqGetVConnInfo, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsProxyUnpackReqLoopback	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyReqLoopback_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyReqLoopback 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 409 of file bsProxyMsgs.h.

References BsProxyMsgIdReqLoopback, and BsProxyUnpackMsg().

Referenced by ReqLoopback().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdReqLoopback, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsProxyUnpackReqMsgTrace	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyReqMsgTrace_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyReqMsgTrace 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 581 of file bsProxyMsgs.h.

References BsProxyMsgIdReqMsgTrace, and BsProxyUnpackMsg().

Referenced by ReqMsgTrace().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdReqMsgTrace, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsProxyUnpackReqSetLogging	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyReqSetLogging_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyReqSetLogging 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 495 of file bsProxyMsgs.h.

References BsProxyMsgIdReqSetLogging, and BsProxyUnpackMsg().

Referenced by ReqSetLogging().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdReqSetLogging, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsProxyUnpackRspDevOpen	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyRspDevOpen_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyRspDevOpen 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 667 of file bsProxyMsgs.h.

References BsProxyMsgIdRspDevOpen, and BsProxyUnpackMsg().

Referenced by bsServerReqOpenDev().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdRspDevOpen, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsProxyUnpackRspErr	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyRspErr_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyRspErr 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 366 of file bsProxyMsgs.h.

References BsProxyMsgIdRspErr, and BsProxyUnpackMsg().

Referenced by bsClientTrans().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdRspErr, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsProxyUnpackRspGetVConnInfo	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyRspGetVConnInfo_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyRspGetVConnInfo 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 839 of file bsProxyMsgs.h.

References BsProxyMsgIdRspGetVConnInfo, and BsProxyUnpackMsg().

Referenced by bsServerReqGetVConnInfo().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdRspGetVConnInfo, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsProxyUnpackRspGetVConnList	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyRspGetVConnList_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyRspGetVConnList 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 753 of file bsProxyMsgs.h.

References BsProxyMsgIdRspGetVConnList, and BsProxyUnpackMsg().

Referenced by bsServerReqGetVConnList().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdRspGetVConnList, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsProxyUnpackRspGetVersion	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyRspGetVersion_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyRspGetVersion 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 538 of file bsProxyMsgs.h.

References BsProxyMsgIdRspGetVersion, and BsProxyUnpackMsg().

Referenced by bsServerReqGetVersion().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdRspGetVersion, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsProxyUnpackRspLoopback	(	byte_t	buf[],
		size_t	uMsgLen,
		BsProxyRspLoopback_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsProxyRspLoopback 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 452 of file bsProxyMsgs.h.

References BsProxyMsgIdRspLoopback, and BsProxyUnpackMsg().

Referenced by bsServerReqLoopback().

 {
   return BsProxyUnpackMsg(BsProxyMsgIdRspLoopback, buf, uMsgLen, pStruct, bTrace);
 }

Variable Documentation

const NMMsgDef_T* BsProxyMsgDefLookupTbl[]

BsProxy Message Definition Look-Up Table. Indexed by BsProxyMsgId_T enum.

Definition at line 814 of file bsProxyMsgs.c.

Referenced by BsProxyLookupMsgDef().

size_t BsProxyMsgMaxLenLookupTbl[]

BsProxy Message Maximum Size Look-Up Table. Indexed by BsProxyMsgId_T enum.

Definition at line 838 of file bsProxyMsgs.c.

Referenced by BsProxyLookupMsgMaxLen().

Classes

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation