Loading...
Searching...
No Matches
Functions
MqContextC_ReadApi_Block_C_API
MQ_C_API » MqContextC_C_API » MqContextC_ReadApi_C_API

MqContextC - read a block-of-data outof a read-data-package … More...

+ Collaboration diagram for MqContextC_ReadApi_Block_C_API:

Functions

MQ_EXTERN enum MkErrorE MqReadL_START_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_BUF buf)
 start to extract a list-items from the read-data-package. …
 
MQ_EXTERN enum MkErrorE MqReadL_END_RT (MK_RT const mkrt, MQ_CTX const ctx)
 finish to extract a list-items from the read-data-package. …
 
MQ_EXTERN enum MkErrorE MqReadT_START_RT (MK_RT const mkrt, MQ_CTX const ctx)
 start to extract a longterm-transaction-item from the read-data-package. …
 
MQ_EXTERN enum MkErrorE MqReadT_END_RT (MK_RT const mkrt, MQ_CTX const ctx)
 finish to extract a longterm-transaction-item from the read-data-package. …
 

MqContextC - MqContextC_ReadApi_Block_C_API - overload

#define MqReadL_END_NULL(...)
 
#define MqReadL_END(...)
 
#define MqReadL_END_E(...)
 
#define MqReadL_END_C(...)
 
#define MqReadL_START_NULL(...)
 
#define MqReadL_START(...)
 
#define MqReadL_START_1(ctx)
 
#define MqReadL_START_E(...)
 
#define MqReadL_START_C(...)
 
#define MqReadT_END_NULL(...)
 
#define MqReadT_END(...)
 
#define MqReadT_END_E(...)
 
#define MqReadT_END_C(...)
 
#define MqReadT_START_NULL(...)
 
#define MqReadT_START(...)
 
#define MqReadT_START_E(...)
 
#define MqReadT_START_C(...)
 

Detailed Description

MqContextC - read a block-of-data outof a read-data-package …

Macro Definition Documentation

◆ MqReadL_END

#define MqReadL_END ( ...)
Value:
MqReadL_END_RT(MK_RT_CALL __VA_ARGS__)
MK_RT_CALL
#define MK_RT_CALL
MqReadL_END_RT
MQ_EXTERN enum MkErrorE MqReadL_END_RT(MK_RT const mkrt, MQ_CTX const ctx)
finish to extract a list-items from the read-data-package. …

Definition at line 461 of file msgque_overload_mq.h.

◆ MqReadL_END_C

#define MqReadL_END_C ( ...)
Value:
if (MkErrorCheckI(MqReadL_END(__VA_ARGS__)))
MqReadL_END
#define MqReadL_END(...)
Definition msgque_overload_mq.h:461

Definition at line 463 of file msgque_overload_mq.h.

◆ MqReadL_END_E

#define MqReadL_END_E ( ...)
Value:
MkErrorCheck(MqReadL_END(__VA_ARGS__))

Definition at line 462 of file msgque_overload_mq.h.

◆ MqReadL_END_NULL

#define MqReadL_END_NULL ( ...)
Value:
MqReadL_END_RT(MK_RT_CALL_NULL __VA_ARGS__)
MK_RT_CALL_NULL
#define MK_RT_CALL_NULL

Definition at line 460 of file msgque_overload_mq.h.

◆ MqReadL_START

#define MqReadL_START ( ...)
Value:
MqReadL_START_RT(MK_RT_CALL __VA_ARGS__)
MqReadL_START_RT
MQ_EXTERN enum MkErrorE MqReadL_START_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_BUF buf)
start to extract a list-items from the read-data-package. …

Definition at line 465 of file msgque_overload_mq.h.

◆ MqReadL_START_1

#define MqReadL_START_1 ( ctx)
Value:
MqReadL_START(ctx,NULL)
MqReadL_START
#define MqReadL_START(...)
Definition msgque_overload_mq.h:465

Definition at line 466 of file msgque_overload_mq.h.

◆ MqReadL_START_C

#define MqReadL_START_C ( ...)
Value:
if (MkErrorCheckI(MqReadL_START(__VA_ARGS__)))

Definition at line 468 of file msgque_overload_mq.h.

◆ MqReadL_START_E

#define MqReadL_START_E ( ...)
Value:
MkErrorCheck(MqReadL_START(__VA_ARGS__))

Definition at line 467 of file msgque_overload_mq.h.

◆ MqReadL_START_NULL

#define MqReadL_START_NULL ( ...)
Value:
MqReadL_START_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 464 of file msgque_overload_mq.h.

◆ MqReadT_END

#define MqReadT_END ( ...)
Value:
MqReadT_END_RT(MK_RT_CALL __VA_ARGS__)
MqReadT_END_RT
MQ_EXTERN enum MkErrorE MqReadT_END_RT(MK_RT const mkrt, MQ_CTX const ctx)
finish to extract a longterm-transaction-item from the read-data-package. …

Definition at line 470 of file msgque_overload_mq.h.

◆ MqReadT_END_C

#define MqReadT_END_C ( ...)
Value:
if (MkErrorCheckI(MqReadT_END(__VA_ARGS__)))
MqReadT_END
#define MqReadT_END(...)
Definition msgque_overload_mq.h:470

Definition at line 472 of file msgque_overload_mq.h.

◆ MqReadT_END_E

#define MqReadT_END_E ( ...)
Value:
MkErrorCheck(MqReadT_END(__VA_ARGS__))

Definition at line 471 of file msgque_overload_mq.h.

◆ MqReadT_END_NULL

#define MqReadT_END_NULL ( ...)
Value:
MqReadT_END_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 469 of file msgque_overload_mq.h.

◆ MqReadT_START

#define MqReadT_START ( ...)
Value:
MqReadT_START_RT(MK_RT_CALL __VA_ARGS__)
MqReadT_START_RT
MQ_EXTERN enum MkErrorE MqReadT_START_RT(MK_RT const mkrt, MQ_CTX const ctx)
start to extract a longterm-transaction-item from the read-data-package. …

Definition at line 474 of file msgque_overload_mq.h.

◆ MqReadT_START_C

#define MqReadT_START_C ( ...)
Value:
if (MkErrorCheckI(MqReadT_START(__VA_ARGS__)))
MqReadT_START
#define MqReadT_START(...)
Definition msgque_overload_mq.h:474

Definition at line 476 of file msgque_overload_mq.h.

◆ MqReadT_START_E

#define MqReadT_START_E ( ...)
Value:
MkErrorCheck(MqReadT_START(__VA_ARGS__))

Definition at line 475 of file msgque_overload_mq.h.

◆ MqReadT_START_NULL

#define MqReadT_START_NULL ( ...)
Value:
MqReadT_START_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 473 of file msgque_overload_mq.h.

Function Documentation

◆ MqReadL_END_RT()

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

finish to extract a list-items from the read-data-package. …

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
Returns
The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk

◆ MqReadL_START_RT()

MQ_EXTERN enum MkErrorE MqReadL_START_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_BUF buf )

start to extract a list-items from the read-data-package. …

Initialize the read with the current body-item or an optional MkBufferC. This command requires a final (runtime) enum MkErrorE MqReadL_END(MQ_CTX const ctx) to finish the read.

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
[in]bufan optional MkBufferC as result from a previous RMqReadBUF call or MK_NULL to use the next item from the read-data-package.
Returns
The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk

◆ MqReadT_END_RT()

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

finish to extract a longterm-transaction-item from the read-data-package. …

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
Returns
The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk

◆ MqReadT_START_RT()

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

start to extract a longterm-transaction-item from the read-data-package. …

Initialize the read with the current-item or an optional MkBufferC. The current-item have to be the first item in the read-data-package. This command requires a final (runtime) enum MkErrorE MqReadL_END(MQ_CTX const ctx) to finish the read.

Example from server.c → read the results from a service-call with transaction-support 

static enum MkErrorE Ot_TRN2 ( MQ_SERVICE_CALL_ARGS )
{
  struct ServerCtxS *srvctx = (struct ServerCtxS*) mqctx;
  MqReadT_START_E (mqctx);
  MqReadI32_E (mqctx, &srvctx->i);
  MqReadT_END_E (mqctx);
  MqReadI32_E (mqctx, &srvctx->j);

  return MK_OK;
error:
  return MkErrorStack_1X (mqctx);
}
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
Returns
The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk
Generated on Wed Sep 25 2024 12:15:44 for theLink by doxygen 1.13.0