MqContextC_ReadApi_Misc_CC_API

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

Collaboration diagram for MqContextC_ReadApi_Misc_CC_API:

Functions
void	ccmqmsgque::MqContextC::ReadDbg ()
	ReadDbg
MkTypeE	ccmqmsgque::MqContextC::ReadGetNextType ()
	C++: MkTypeE ctx.ReadGetNextType() → C-API get the type (MkTypeE) of the next Item in the read-data-buffer or "0" if not available
MK_NUM	ccmqmsgque::MqContextC::ReadGetNumItems ()
	C++: MK_NUM ctx.ReadGetNumItems() → C-API get the number of items left in the read-data-package …
MK_BOOL	ccmqmsgque::MqContextC::ReadItemExists ()
	C++: MK_BOOL ctx.ReadItemExists() → C-API check if an item exists in the read-data-package …
void	ccmqmsgque::MqContextC::ReadUndo ()
	C++: ctx.ReadUndo() → C-API undo the last MqContextC READ API function call …

Detailed Description

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

Function Documentation

ReadDbg()

void ccmqmsgque::MqContextC::ReadDbg ( )

inline

ReadDbg

Definition at line 1283 of file MqContextC_inline_cc.hh.

                                    {
    MK_UNUSED auto ctx = getCTX();
    MqReadDbg(ctx);
  }

ReadGetNextType()

MkTypeE ccmqmsgque::MqContextC::ReadGetNextType ( )

inline

C++: MkTypeE ctx.ReadGetNextType() → C-API
get the type (MkTypeE) of the next Item in the read-data-buffer or "0" if not available

Definition at line 1289 of file MqContextC_inline_cc.hh.

                                               {
    MK_UNUSED auto ctx = getCTX();
    enum MkTypeE __retVal__L = MqReadGetNextType(ctx);
    return __retVal__L;
  }

ReadGetNumItems()

MK_NUM ccmqmsgque::MqContextC::ReadGetNumItems ( )

inline

C++: MK_NUM ctx.ReadGetNumItems() → C-API
get the number of items left in the read-data-package …

Definition at line 1296 of file MqContextC_inline_cc.hh.

                                              {
    MK_UNUSED auto ctx = getCTX();
    MK_NUM __retVal__L = MqReadGetNumItems(ctx);
    return __retVal__L;
  }

ReadItemExists()

MK_BOOL ccmqmsgque::MqContextC::ReadItemExists ( )

inline

C++: MK_BOOL ctx.ReadItemExists() → C-API
check if an item exists in the read-data-package …

Definition at line 1303 of file MqContextC_inline_cc.hh.

                                              {
    MK_UNUSED auto ctx = getCTX();
    MK_BOOL __retVal__L = MqReadItemExists(ctx);
    return __retVal__L;
  }

Here is the caller graph for this function:

ReadUndo()

void ccmqmsgque::MqContextC::ReadUndo ( )

inline

C++: ctx.ReadUndo() → C-API
undo the last MqContextC READ API function call …

Definition at line 1310 of file MqContextC_inline_cc.hh.

                                     {
    MK_UNUSED auto ctx = getCTX();
    enum MkErrorE errVal = MqReadUndo(ctx);
    MkErrorC_Check(ctx, errVal);
  }