MqReadS API
[MqS API]

reading a Msgque packet and splitting it into several items. More...

Functions
MQ_EXTERN void	MqReadCreate_LST_Ref (MqReadSP const in, const MqBufferSP buf, MqReadSP *out)
	creating a LST reference for reading the list items
MQ_EXTERN void	MqReadDelete_LST_Ref (MqReadSP *readP)
	deleting a LST reference after reading the list items was finished
MQ_EXTERN void	MqReadCreate_RET_Ref (MqReadSP const in, MqReadSP *out)
	creating a RET reference for reading the return items
MQ_EXTERN void	MqReadDelete_RET_Ref (MqReadSP *readP)
	deleting a RET reference after reading the return items was finished
MQ_EXTERN MqErrorE	MqReadRET (MqReadSP const read, MqBufferSP const buf)
	read the header of a return object from the MqReadS
MQ_EXTERN MqErrorE	MqReadU (MqReadSP const read, MqBufferSP *out)
	read a MqBufferS from the MqReadS
MQ_EXTERN void	MqReadUDecr (MqReadSP const read, const MqBufferSP buf)
	put the MqBufferS back on the MqReadS stack
MQ_EXTERN MqErrorE	MqRead2 (MqReadSP const read, MQ_INT2 *out)
	read a MQ_INT2 from the MqReadS
MQ_EXTERN MqErrorE	MqRead4 (MqReadSP const read, MQ_INT4 *out)
	read a MQ_INT4 from the MqReadS
MQ_EXTERN MqErrorE	MqRead8 (MqReadSP const read, MQ_INT8 *out)
	read a MQ_INT8 from the MqReadS
MQ_EXTERN MqErrorE	MqReadF (MqReadSP const read, MQ_FLT4 *out)
	read a MQ_FLT4 from the MqReadS
MQ_EXTERN MqErrorE	MqReadD (MqReadSP const read, MQ_FLT8 *out)
	read a MQ_FLT8 from the MqReadS
MQ_EXTERN MqErrorE	MqReadP (MqReadSP const read, MQ_PTR *out)
	read a MQ_PTR from the MqReadS
MQ_EXTERN MqErrorE	MqReadC (MqReadSP const read, MQ_STR *out)
	read a MQ_STR from the MqReadS
MQ_EXTERN MqErrorE	MqReadArgv (MqReadSP const read, int *argc, char ***argv)
	split the entire MqReadS stack into an argc/argv array. Attention: the items in argv are using temporally memory under control of MqReadS. it is not allowed to free the argv items.
MQ_EXTERN MQ_SIZE	MqReadGetNumItems (MqReadSP const read)
	get the number of items left in the MqReadS item stack
MQ_EXTERN char	MqReadGetReturnCode (MqReadSP const read)
	get the return-code of the current Msgque packet from the MqReadS object
MQ_EXTERN MQ_INT2	MqReadGetReturnNum (MqReadSP const read)
	get the return-number of the current Msgque packet from the MqReadS object
MQ_EXTERN MqSP	MqReadGetMsgque (MqReadSP const read)
	get the MqS object belonging to the current MqReadS object

---

Detailed Description

reading a Msgque packet and splitting it into several items.

the management is done by a MqReadS object using a MqIoS object for doing the socket io. every MqS object has only one MqReadS object and every MqReadS object has only one MqS object.

Change for 2.0:

no need for public Token-Api, only internal use
DELETE: MqTokenAddHdl
DELETE: MqTokenDelHdl

---

Function Documentation

MQ_EXTERN MqErrorE MqReadArgv (  MqReadSP const   read, int *  argc, char ***  argv )

split the entire MqReadS stack into an argc/argv array. Attention: the items in argv are using temporally memory under control of MqReadS. it is not allowed to free the argv items. Returns: error code Parameters: read  the MqReadS object to work on argc  the number of items in argv argv  the array of items

MQ_EXTERN void MqReadCreate_LST_Ref (  MqReadSP const   in, const MqBufferSP  buf, MqReadSP *  out )

creating a LST reference for reading the list items Change for 2.0: return void and not MqErrorE

MQ_EXTERN void MqReadCreate_RET_Ref (  MqReadSP const   in, MqReadSP *  out )

creating a RET reference for reading the return items Change for 2.0: return void and not MqErrorE

MQ_EXTERN void MqReadDelete_LST_Ref (  MqReadSP *  readP  )

deleting a LST reference after reading the list items was finished Change for 2.0: return void and not MqErrorE

MQ_EXTERN void MqReadDelete_RET_Ref (  MqReadSP *  readP  )

deleting a RET reference after reading the return items was finished Change for 2.0: return void and not MqErrorE

---