BotSense Server-Wide Message Unique Id Attributes

Macros
#define	BSPROXY_MSGUID_VCONN_SHIFT   16
	v.conn bit shift
#define	BSPROXY_MSGUID_VCONN_MASK   (BSPROXY_VCONN_MASK << BSPROXY_MSGUID_VCONN_SHIFT)
	v.connection mask
#define	BSPROXY_MSGUID_MSGID_MASK   (BSPROXY_MSGID_MASK)
	app message id mask
#define	BSPROXY_MAKE_MSGUID(hndVConn, msgid)
	Make a MSGUID. More...
#define	BSPROXY_MAKE_SERVER_MSGUID(msgid)   BSPROXY_MAKE_MSGUID(BSPROXY_VCONN_SERVER, msgid)
	Make a server-specific MSGUID. More...
#define	BSPROXY_GET_MSGUID_HND(msguid)
	Get the virtual connection handle from the MSGUID. More...
#define	BSPROXY_GET_MSGUID_MSGID(msguid)   (BsMsgUid_T)( ((msguid) & BSPROXY_MSGUID_MSGID_MASK) )
	Get the message id from the MSGUID. More...

Typedefs
typedef uint_t	BsMsgUid_T
	client message unique id

Detailed Description

A MSGUID is a server instance unique message id. It is the combination of the server assigned virtual connection handle (or the reserved server handle) and the application-specific message id.

Although the MSGUID is not used by the BotSense client library nor by the bsProxy server directly, it can be a useful construct for client applications that need this level of uniqueness. The MSGUID is composed if two values:

• Virtual connection handle.
• Application-specific message id.

Macro Definition Documentation

#define BSPROXY_GET_MSGUID_HND

(

msguid

)

Value:

(BsMsgUid_T)( \
      (((msguid) >> BSPROXY_MSGUID_VCONN_SHFIT) & BSPROXY_MSGUID_VCONN_MASK) )

Get the virtual connection handle from the MSGUID.

Parameters

msguid

MSGUID.

Definition at line 234 of file BotSense.h.

#define BSPROXY_GET_MSGUID_MSGID

(

msguid

)

(BsMsgUid_T)( ((msguid) & BSPROXY_MSGUID_MSGID_MASK) )

Get the message id from the MSGUID.

Parameters

msguid

MSGUID.

Definition at line 242 of file BotSense.h.

#define BSPROXY_MAKE_MSGUID	(		hndVConn,
			msgid
	)

Value:

(BsMsgUid_T)( \
      (((hndVConn) << BSPROXY_MSGUID_VCONN_SHIFT) & BSPROXY_MSGUID_VCONN_MASK) \
    | ((msgid) & BSPROXY_MSGUID_MSGID_MASK) )

Make a MSGUID.

Parameters

hndVConn	Virtual connection handle.
msgid	Application specific message id.

Definition at line 218 of file BotSense.h.

Referenced by ThQReqCmp().

#define BSPROXY_MAKE_SERVER_MSGUID

(

msgid

)

BSPROXY_MAKE_MSGUID(BSPROXY_VCONN_SERVER, msgid)

Make a server-specific MSGUID.

Parameters

msgid

Application specific message id.

Definition at line 227 of file BotSense.h.