MqContextC_ReadApi_Misc_C_API

MqContextC - various functions to work on a read-data-package … More...

Collaboration diagram for MqContextC_ReadApi_Misc_C_API:

Functions
MQ_EXTERN void	MqReadDbg_RT (MK_RT const mkrt, MQ_CTX const ctx)
MQ_EXTERN enum MkErrorE	MqReadUndo_RT (MK_RT const mkrt, MQ_CTX const ctx)
	undo the last MqContextC READ API function call …
MQ_EXTERN MK_NUM	MqReadGetNumItems (MQ_CTX const ctx) MK_ATTR_HDL
	get the number of items left in the read-data-package …
MQ_EXTERN enum MkTypeE	MqReadGetNextType (MQ_CTX const ctx) MK_ATTR_HDL
	get the type (MkTypeE) of the next Item in the read-data-buffer or "0" if not available
MQ_EXTERN bool	MqReadItemExists (MQ_CTX const ctx) MK_ATTR_HDL
	check if an item exists in the read-data-package …
MQ_EXTERN enum MqTransTypeE	MqReadGetTransType (MQ_CTX const ctx) MK_ATTR_HDL
	return the TransactionType identifer …
MQ_EXTERN enum MqHandShakeE	MqReadGetHandShake (MQ_CTX const ctx) MK_ATTR_HDL
	return the HandShake identifer …

MqContextC - MqContextC_ReadApi_Misc_C_API - overload
#define	MqReadDbg_NULL(...)
#define	MqReadDbg(...)
#define	MqReadUndo_NULL(...)
#define	MqReadUndo(...)
#define	MqReadUndo_E(...)
#define	MqReadUndo_C(...)

Detailed Description

MqContextC - various functions to work on a read-data-package …

Macro Definition Documentation

MqReadDbg

#define MqReadDbg

(

...

)

Value:

MqReadDbg_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 487 of file msgque_overload_mq.h.

MqReadDbg_NULL

#define MqReadDbg_NULL

(

...

)

Value:

MqReadDbg_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 486 of file msgque_overload_mq.h.

MqReadUndo

#define MqReadUndo

(

...

)

Value:

MqReadUndo_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 489 of file msgque_overload_mq.h.

MqReadUndo_C

#define MqReadUndo_C

(

...

)

Value:

if (MkErrorCheckI(MqReadUndo(__VA_ARGS__)))

Definition at line 491 of file msgque_overload_mq.h.

MqReadUndo_E

#define MqReadUndo_E

(

...

)

Value:

MkErrorCheck(MqReadUndo(__VA_ARGS__))

Definition at line 490 of file msgque_overload_mq.h.

MqReadUndo_NULL

#define MqReadUndo_NULL

(

...

)

Value:

MqReadUndo_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 488 of file msgque_overload_mq.h.

Function Documentation

MqReadDbg_RT()

MQ_EXTERN void MqReadDbg_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx )

MqReadGetHandShake()

MQ_EXTERN enum MqHandShakeE MqReadGetHandShake

(

MQ_CTX const

ctx

)

return the HandShake identifer …

Parameters

[in]

ctx

the MqContextS instance to work on

Returns

MqHandShakeE

MqReadGetNextType()

MQ_EXTERN enum MkTypeE MqReadGetNextType

(

MQ_CTX const

ctx

)

get the type (MkTypeE) of the next Item in the read-data-buffer or "0" if not available

Parameters

[in]

ctx

the MqContextS instance to work on

Returns

the type

MqReadGetNumItems()

MQ_EXTERN MK_NUM MqReadGetNumItems

(

MQ_CTX const

ctx

)

get the number of items left in the read-data-package …

Parameters

[in]

ctx

the MqContextS instance to work on

Returns

the number of items as integer

MqReadGetTransType()

MQ_EXTERN enum MqTransTypeE MqReadGetTransType

(

MQ_CTX const

ctx

)

return the TransactionType identifer …

Parameters

[in]

ctx

the MqContextS instance to work on

Returns

MqTransTypeE

MqReadItemExists()

MQ_EXTERN bool MqReadItemExists

(

MQ_CTX const

ctx

)

check if an item exists in the read-data-package …

Parameters

[in]

ctx

the MqContextS instance to work on

Returns

boolean, MK_YES or MK_NO

MqReadUndo_RT()

MQ_EXTERN enum MkErrorE MqReadUndo_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx )

undo the last MqContextC READ API function call …

Put the internal position-pointer to the start of the last read body-item. The next read function call will extract the same item again. Only one undo level is supported.

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	ctx	the MqContextS instance to work on

Returns

The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk