MqBufferS Struct Reference
[MqBufferS API]

defines an object to store generic (e.g mixed typed) data. More...

#include <types.h>

List of all members.

Public Attributes
MqErrorSP	error
	link to the current MqErrorS object
MQ_BIN	data
	always point to the beginning of the data-segment
MQ_SIZE	size
	the size of the data-segment
MQ_SIZE	cursize
	currently used size (always: cursize < size)
MQ_SIZE	numItems
	the number of items in the data-segment (only if it is a package)
MqBufferU	cur
	a package (always: data <= cur.B <= data+cursize)
MqAllocE	alloc
	allocation style, MQ_DYNAMIC or MQ_STATIC
MqTypeE	type
	type of the item stored into the data-segment

---

Detailed Description

defines an object to store generic (e.g mixed typed) data.

an MqBufferS object is used for 3 different purposes:

• store generic typed single data value
• build a Msgque packet by appending items to an existing object
• read a single item from an existing Msgque packet

'reading from' and 'appending to' an existing Msgque packet is done by incrementing the cur.B pointer to a new position. an MqBufferS object is using a MqBufferU union and a MqTypeE enum to define an item. the object is public to give the developer the opportunity to direct access stored data like.

Example:

using a switch to process different MqTypeE

switch (buf->type) {
   case MQ_INT2: ... *buf->cur.I2 ... ; break
   case MQ_FLT4: ... *buf->cur.F  ... ; break
   ....
}

Change for 2.0:

DELETE: MqBufferCreateRef

Definition at line 700 of file types.h.

---

Member Data Documentation

MqBufferU MqBufferS::cur

a package (always: data <= cur.B <= data+cursize) point to current position, used for 'appending to' or 'reading from' Definition at line 706 of file types.h.

---

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

• types.h

---