BotSense Message Header Attributes

Classes
struct	BsProxyMsgHdr_T
	BotSense Proxy Message Header Structure. More...

Macros
#define	BSPROXY_MSG_HDR_LEN   8
	message header length (bytes)
#define	BSPROXY_MSG_MAX_LEN   (BSPROXY_MSG_HDR_LEN+BSPROXY_MSG_BODY_MAX)
	total message maximum length
#define	BSPROXY_MSG_MAGIC   0xaaaa
	message magic pattern
#define	BSPROXY_BUF_BODY(buf)   (buf)+BSPROXY_MSG_HDR_LEN, sizeof(buf)-(size_t)BSPROXY_MSG_HDR_LEN
	Convenience macro to produce a buffer (offset, size) 2-tuple. More...

Detailed Description

All BotSense server-directed message requests and client-directed responses contain a fixed-format message header.

Macro Definition Documentation

#define BSPROXY_BUF_BODY

(

buf

)

(buf)+BSPROXY_MSG_HDR_LEN, sizeof(buf)-(size_t)BSPROXY_MSG_HDR_LEN

Convenience macro to produce a buffer (offset, size) 2-tuple.

The offset allows libbsclient to pack the header in front of the buffer without doing any unnecessary copies, while the buffer size is decremented to account for the header bytes to be packed.

Parameters

buf

Buffer.

Definition at line 272 of file BotSense.h.

Referenced by bsI2CReqRead(), bsI2CReqTrans(), bsI2CReqWrite(), bsModI2CReqRead(), bsModI2CReqScan(), bsModI2CReqTrans(), bsModI2CReqWrite(), bsModNullReqWrite(), bsModSerialReqRead(), bsModSerialReqTrans(), bsModSerialReqWrite(), bsNullReqWrite(), bsSerialReqRead(), bsSerialReqTrans(), bsSerialReqWrite(), bsServerReqCloseDev(), bsServerReqGetVConnInfo(), bsServerReqLoopback(), bsServerReqMsgTrace(), bsServerReqOpenDev(), bsServerReqSetLogging(), and ClientSendServerRsp().