liblogging: sbFramObject struct Reference

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

# sbFramObject Struct Reference

The BEEP frame object. More...

`#include <beepframe.h>`

List of all members.

## Public Attributes
srObjID | OID
| Object ID - to make code (more ;)) bulletproof.
sMesgObject * | pMsg
| pointer to the message this frame belongs to
sbFramState | iState
| status of this frame
char * | szRawBuf
| pointer to the complete frame text
int | iFrameLen
| size (in Bytes) of the complete frame
BEEPHdrID | idHdr
| the header id of this frame
SBackno | uAckno
| RFC 3081 ackno.
SBwindow | uWindow
| RFC 3081 window.
SBchannel | uChannel
| RFC 3080 channel.
SBmsgno | uMsgno
| RFC 3080 msgno.
SBseqno | uSeqno
| RFC 3080 seqno.
SBsize | uSize
| RFC 3080 size.
char | cMore
| RFC 3080 more.
SBansno | uAnsno
| RFC 3080 ansno.
unsigned | uBytesSend
| number of bytes already send
sbChanObject * | pChan
| channel to send over (shortcut to save performance)
sbStrBObject * | pStrBuf
| work buffer for receiving frames
unsigned | uToReceive
| number of payload characters (still) to be recieved
void(* | OnFramDestroy )(struct sbFramObject *)
| callback to be called when frame is destroyed
void * | pUsr
| user pointer to be passed to callback OnFramDestroy()

## Detailed Description

The BEEP frame object.

Implemented via beepframe::h and beepframe::c.

## Member Data Documentation

struct sMesgObject* sbFramObject::pMsg

| pointer to the message this frame belongs to May be NULL if the frame does NOT belong to a message (SEQ frame!)

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

- beepframe.h