liblogging: sbMesgObject struct Reference

Main Page | Compound List | File List | Compound Members | File Members | Related Pages

# sbMesgObject Struct Reference

The BEEP message object. More...

`#include <beepmessage.h>`

List of all members.

## Public Attributes
srObjID | OID
| Object ID - to make code (more ;)) bulletproof.
BEEPHdrID | idHdr
| the header id of this frame
SBmsgno | uMsgno
| the message number of this message (from header)
SBseqno | uSeqno
| RFC 3080 seqno (from header).
SBseqno | uNxtSeqno
| expected next seqno on the channel (for RFC 3081 SEQ)
char * | szRawBuf
| pointer to the complete message text
char * | szMIMEHdr
| the message's MIME header (NULL, if no headers were provided)
char * | szActualPayload
| the *actual* payload, that is message without MIME headers and without the CRLF MIME header separator
int | bRawDirty
| TRUE, if szRawBuf does not contain a proper full representation of the message.
int | iPayloadSize
| size (in bytes) of the actual payload
int | iMIMEHdrSize
| size (in bytes) of the MIME headers
int | iOverallSize
| size (in bytes) of the whole message

## Detailed Description

The BEEP message object.

Implemented via beepmessage::h and beepmessage::c.

## Member Data Documentation

int sbMesgObject::bRawDirty

| TRUE, if szRawBuf does not contain a proper full representation of the message. FALSE otherwise. This is used when generating messages. It may improve performance if we e.g. add MIME headers first before assemblin the final message. NOT CURRENTLY USED.

char* sbMesgObject::szActualPayload

| the *actual* payload, that is message without MIME headers and without the CRLF MIME header separator szActualPayload POINTS DIRECTLY INTO THE RAW MESSAGE BUFFER. This is for performance reasons. As it is no buffer into its own right, it MUST NEVER be free()ed!

The documentation for this struct was generated from the following file:

- beepmessage.h