theLink 10.0 NHI1 - theKernel - theLink - theConfig - theSq3Lite - theCompiler - theBrain - theGuard
c - tcl - cs - py - rb - jv - cc
Loading...
Searching...
No Matches
MqContextC_ReadApi_Misc_C_API

MqContextC - various functions to work on a read-data-packageMore...

+ Collaboration diagram for MqContextC_ReadApi_Misc_C_API:

Functions

void MqReadDbg_RT (MK_RT mkrt, MQ_CTX const ctx)
 
enum MkErrorE MqReadUndo_RT (MK_RT mkrt, MQ_CTX const ctx)
 undo the last MqContextC READ API function call …
 
MK_NUM MqReadGetNumItems (MQ_CTX const ctx)
 get the number of items left in the read-data-package
 
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
 
bool MqReadItemExists (MQ_CTX const ctx)
 check if an item exists in the read-data-package
 
enum MqTransTypeE MqReadGetTransType (MQ_CTX const ctx)
 return the TransactionType identifer …
 
enum MqHandShakeE MqReadGetHandShake (MQ_CTX const ctx)
 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:
#define MK_RT_CALL
void MqReadDbg_RT(MK_RT mkrt, MQ_CTX const ctx)

Definition at line 489 of file msgque_overload_mq.h.

◆ MqReadDbg_NULL

#define MqReadDbg_NULL ( ...)
Value:
#define MK_RT_CALL_NULL

Definition at line 488 of file msgque_overload_mq.h.

◆ MqReadUndo

#define MqReadUndo ( ...)
Value:
enum MkErrorE MqReadUndo_RT(MK_RT mkrt, MQ_CTX const ctx)
undo the last MqContextC READ API function call …

Definition at line 491 of file msgque_overload_mq.h.

◆ MqReadUndo_C

#define MqReadUndo_C ( ...)
Value:
if (MkErrorCheckI(MqReadUndo(__VA_ARGS__)))
#define MqReadUndo(...)

Definition at line 493 of file msgque_overload_mq.h.

◆ MqReadUndo_E

#define MqReadUndo_E ( ...)
Value:
MkErrorCheck(MqReadUndo(__VA_ARGS__))

Definition at line 492 of file msgque_overload_mq.h.

◆ MqReadUndo_NULL

#define MqReadUndo_NULL ( ...)
Value:

Definition at line 490 of file msgque_overload_mq.h.

Function Documentation

◆ MqReadDbg_RT()

void MqReadDbg_RT ( MK_RT mkrt,
MQ_CTX const ctx )

◆ MqReadGetHandShake()

enum MqHandShakeE MqReadGetHandShake ( MQ_CTX const ctx)

return the HandShake identifer …

Parameters
[in]ctxthe MqContextS instance to work on
Returns
MqHandShakeE

◆ MqReadGetNextType()

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]ctxthe MqContextS instance to work on
Returns
the type
+ Here is the caller graph for this function:

◆ MqReadGetNumItems()

MK_NUM MqReadGetNumItems ( MQ_CTX const ctx)

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

Parameters
[in]ctxthe MqContextS instance to work on
Returns
the number of items as integer
+ Here is the caller graph for this function:

◆ MqReadGetTransType()

enum MqTransTypeE MqReadGetTransType ( MQ_CTX const ctx)

return the TransactionType identifer …

Parameters
[in]ctxthe MqContextS instance to work on
Returns
MqTransTypeE

◆ MqReadItemExists()

bool MqReadItemExists ( MQ_CTX const ctx)

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

Parameters
[in]ctxthe MqContextS instance to work on
Returns
boolean, True or False
+ Here is the caller graph for this function:

◆ MqReadUndo_RT()

enum MkErrorE MqReadUndo_RT ( MK_RT 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]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)