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

MqContextC - read a single-data-item outof a read-data-package … More...

+ Collaboration diagram for MqContextC_ReadApi_Atom_C_API:

Functions

MQ_EXTERN enum MkErrorE MqReadI8_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_I8 *const val_out)
 read a PRIMITIVE TYPE from the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadBOL_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_BOL *const val_out)
 read a PRIMITIVE TYPE from the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadI16_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_I16 *const val_out)
 read a PRIMITIVE TYPE from the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadI32_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_I32 *const val_out)
 read a PRIMITIVE TYPE from the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadFLT_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_FLT *const val_out)
 read a PRIMITIVE TYPE from the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadI64_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_I64 *const val_out)
 read a PRIMITIVE TYPE from the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadDBL_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_DBL *const val_out)
 read a PRIMITIVE TYPE from the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadBUF_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_BUF *const val_out)
 get a temporary MkBufferC from the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadBFL_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_BFL *const val_out)
 get a temporary MkBufferListC from next list-item in the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadALL_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_BFL *const val_inout)
 get a temporary MkBufferListC from all data in the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadLIST_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_NAT_LIST *const val_out)
 get all arguments as native list …
 
MQ_EXTERN enum MkErrorE MqReadNEXT_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_NAT_OBJECT *const val_out)
 get the next argument as native object …
 
MQ_EXTERN enum MkErrorE MqReadLONG_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_LONG *const val_out)
 read the long native object from the read-data-package
 
MQ_EXTERN enum MkErrorE MqReadHDL_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_HDL *const val_out)
 read the handle from the read-data-package
 
MQ_EXTERN enum MkErrorE MqReadSTR_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_STRN *const val_out)
 read a PRIMITIVE TYPE from the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadBIN_RT (MK_RT const mkrt, MQ_CTX const ctx, MkBinaryR *const val_out)
 generic function to read an MK_BIN object from the read-data-package object …
 
MQ_EXTERN enum MkErrorE MqReadStringR_RT (MK_RT const mkrt, MQ_CTX const ctx, MkStringR *const val_out)
 read a MkStringR from the read-data-package …
 
MQ_EXTERN enum MkErrorE MqReadBinaryR_RT (MK_RT const mkrt, MQ_CTX const ctx, MkBinaryR *const val_out)
 read a MkBinaryR from the read-data-package …
 

MqContextC - MqContextC_ReadApi_Atom_C_API - overload

#define MqReadALL_NULL(...)
 
#define MqReadALL(...)
 
#define MqReadALL_E(...)
 
#define MqReadALL_C(...)
 
#define MqReadALL_e(...)
 
#define MqReadBFL_NULL(...)
 
#define MqReadBFL(...)
 
#define MqReadBFL_E(...)
 
#define MqReadBFL_C(...)
 
#define MqReadBFL_e(...)
 
#define MqReadBUF_NULL(...)
 
#define MqReadBUF(...)
 
#define MqReadBUF_E(...)
 
#define MqReadBUF_C(...)
 
#define MqReadBUF_e(...)
 
#define MqReadBIN_NULL(...)
 
#define MqReadBIN(...)
 
#define MqReadBIN_E(...)
 
#define MqReadBIN_C(...)
 
#define MqReadBIN_e(...)
 
#define MqReadBOL_NULL(...)
 
#define MqReadBOL(...)
 
#define MqReadBOL_E(...)
 
#define MqReadBOL_C(...)
 
#define MqReadBOL_e(...)
 
#define MqReadBinaryR_NULL(...)
 
#define MqReadBinaryR(...)
 
#define MqReadBinaryR_E(...)
 
#define MqReadBinaryR_C(...)
 
#define MqReadBinaryR_e(...)
 
#define MqReadDBL_NULL(...)
 
#define MqReadDBL(...)
 
#define MqReadDBL_E(...)
 
#define MqReadDBL_C(...)
 
#define MqReadDBL_e(...)
 
#define MqReadFLT_NULL(...)
 
#define MqReadFLT(...)
 
#define MqReadFLT_E(...)
 
#define MqReadFLT_C(...)
 
#define MqReadFLT_e(...)
 
#define MqReadHDL_NULL(...)
 
#define MqReadHDL(...)
 
#define MqReadHDL_E(...)
 
#define MqReadHDL_C(...)
 
#define MqReadHDL_e(...)
 
#define MqReadI16_NULL(...)
 
#define MqReadI16(...)
 
#define MqReadI16_E(...)
 
#define MqReadI16_C(...)
 
#define MqReadI16_e(...)
 
#define MqReadI32_NULL(...)
 
#define MqReadI32(...)
 
#define MqReadI32_E(...)
 
#define MqReadI32_C(...)
 
#define MqReadI32_e(...)
 
#define MqReadI64_NULL(...)
 
#define MqReadI64(...)
 
#define MqReadI64_E(...)
 
#define MqReadI64_C(...)
 
#define MqReadI64_e(...)
 
#define MqReadI8_NULL(...)
 
#define MqReadI8(...)
 
#define MqReadI8_E(...)
 
#define MqReadI8_C(...)
 
#define MqReadI8_e(...)
 
#define MqReadLIST_NULL(...)
 
#define MqReadLIST(...)
 
#define MqReadLIST_E(...)
 
#define MqReadLIST_C(...)
 
#define MqReadLIST_e(...)
 
#define MqReadLONG_NULL(...)
 
#define MqReadLONG(...)
 
#define MqReadLONG_E(...)
 
#define MqReadLONG_C(...)
 
#define MqReadLONG_e(...)
 
#define MqReadNEXT_NULL(...)
 
#define MqReadNEXT(...)
 
#define MqReadNEXT_E(...)
 
#define MqReadNEXT_C(...)
 
#define MqReadNEXT_e(...)
 
#define MqReadSTR_NULL(...)
 
#define MqReadSTR(...)
 
#define MqReadSTR_E(...)
 
#define MqReadSTR_C(...)
 
#define MqReadSTR_e(...)
 
#define MqReadStringR_NULL(...)
 
#define MqReadStringR(...)
 
#define MqReadStringR_E(...)
 
#define MqReadStringR_C(...)
 
#define MqReadStringR_e(...)
 

Detailed Description

MqContextC - read a single-data-item outof a read-data-package …

Macro Definition Documentation

◆ MqReadALL

#define MqReadALL ( ...)
Value:
MqReadALL_RT(MK_RT_CALL __VA_ARGS__)
MK_RT_CALL
#define MK_RT_CALL
MqReadALL_RT
MQ_EXTERN enum MkErrorE MqReadALL_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_BFL *const val_inout)
get a temporary MkBufferListC from all data in the read-data-package …

Definition at line 358 of file msgque_overload_mq.h.

◆ MqReadALL_C

#define MqReadALL_C ( ...)
Value:
if (MkErrorCheckI(MqReadALL(__VA_ARGS__)))
MqReadALL
#define MqReadALL(...)
Definition msgque_overload_mq.h:358

Definition at line 360 of file msgque_overload_mq.h.

◆ MqReadALL_E

#define MqReadALL_E ( ...)
Value:
MkErrorCheck(MqReadALL(__VA_ARGS__))

Definition at line 359 of file msgque_overload_mq.h.

◆ MqReadALL_e

#define MqReadALL_e ( ...)
Value:
MK_EMBEDDED(MK_BFL,MqReadALL,__VA_ARGS__)
MK_EMBEDDED
#define MK_EMBEDDED(type, call,...)

Definition at line 361 of file msgque_overload_mq.h.

◆ MqReadALL_NULL

#define MqReadALL_NULL ( ...)
Value:
MqReadALL_RT(MK_RT_CALL_NULL __VA_ARGS__)
MK_RT_CALL_NULL
#define MK_RT_CALL_NULL

Definition at line 357 of file msgque_overload_mq.h.

◆ MqReadBFL

#define MqReadBFL ( ...)
Value:
MqReadBFL_RT(MK_RT_CALL __VA_ARGS__)
MqReadBFL_RT
MQ_EXTERN enum MkErrorE MqReadBFL_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_BFL *const val_out)
get a temporary MkBufferListC from next list-item in the read-data-package …

Definition at line 365 of file msgque_overload_mq.h.

◆ MqReadBFL_C

#define MqReadBFL_C ( ...)
Value:
if (MkErrorCheckI(MqReadBFL(__VA_ARGS__)))
MqReadBFL
#define MqReadBFL(...)
Definition msgque_overload_mq.h:365

Definition at line 367 of file msgque_overload_mq.h.

◆ MqReadBFL_E

#define MqReadBFL_E ( ...)
Value:
MkErrorCheck(MqReadBFL(__VA_ARGS__))

Definition at line 366 of file msgque_overload_mq.h.

◆ MqReadBFL_e

#define MqReadBFL_e ( ...)
Value:
MK_EMBEDDED(MK_BFL,MqReadBFL,__VA_ARGS__)

Definition at line 368 of file msgque_overload_mq.h.

◆ MqReadBFL_NULL

#define MqReadBFL_NULL ( ...)
Value:
MqReadBFL_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 364 of file msgque_overload_mq.h.

◆ MqReadBIN

#define MqReadBIN ( ...)
Value:
MqReadBIN_RT(MK_RT_CALL __VA_ARGS__)
MqReadBIN_RT
MQ_EXTERN enum MkErrorE MqReadBIN_RT(MK_RT const mkrt, MQ_CTX const ctx, MkBinaryR *const val_out)
generic function to read an MK_BIN object from the read-data-package object …

Definition at line 377 of file msgque_overload_mq.h.

◆ MqReadBIN_C

#define MqReadBIN_C ( ...)
Value:
if (MkErrorCheckI(MqReadBIN(__VA_ARGS__)))
MqReadBIN
#define MqReadBIN(...)
Definition msgque_overload_mq.h:377

Definition at line 379 of file msgque_overload_mq.h.

◆ MqReadBIN_E

#define MqReadBIN_E ( ...)
Value:
MkErrorCheck(MqReadBIN(__VA_ARGS__))

Definition at line 378 of file msgque_overload_mq.h.

◆ MqReadBIN_e

#define MqReadBIN_e ( ...)
Value:
MK_EMBEDDED_REF(MkBinaryR,MqReadBIN,__VA_ARGS__)
MK_EMBEDDED_REF
#define MK_EMBEDDED_REF(type, call,...)

Definition at line 380 of file msgque_overload_mq.h.

◆ MqReadBIN_NULL

#define MqReadBIN_NULL ( ...)
Value:
MqReadBIN_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 376 of file msgque_overload_mq.h.

◆ MqReadBinaryR

#define MqReadBinaryR ( ...)
Value:
MqReadBinaryR_RT(MK_RT_CALL __VA_ARGS__)
MqReadBinaryR_RT
MQ_EXTERN enum MkErrorE MqReadBinaryR_RT(MK_RT const mkrt, MQ_CTX const ctx, MkBinaryR *const val_out)
read a MkBinaryR from the read-data-package …

Definition at line 387 of file msgque_overload_mq.h.

◆ MqReadBinaryR_C

#define MqReadBinaryR_C ( ...)
Value:
if (MkErrorCheckI(MqReadBinaryR(__VA_ARGS__)))
MqReadBinaryR
#define MqReadBinaryR(...)
Definition msgque_overload_mq.h:387

Definition at line 389 of file msgque_overload_mq.h.

◆ MqReadBinaryR_E

#define MqReadBinaryR_E ( ...)
Value:
MkErrorCheck(MqReadBinaryR(__VA_ARGS__))

Definition at line 388 of file msgque_overload_mq.h.

◆ MqReadBinaryR_e

#define MqReadBinaryR_e ( ...)
Value:
MK_EMBEDDED_REF(MkBinaryR,MqReadBinaryR,__VA_ARGS__)

Definition at line 390 of file msgque_overload_mq.h.

◆ MqReadBinaryR_NULL

#define MqReadBinaryR_NULL ( ...)
Value:
MqReadBinaryR_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 386 of file msgque_overload_mq.h.

◆ MqReadBOL

#define MqReadBOL ( ...)
Value:
MqReadBOL_RT(MK_RT_CALL __VA_ARGS__)
MqReadBOL_RT
MQ_EXTERN enum MkErrorE MqReadBOL_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_BOL *const val_out)
read a PRIMITIVE TYPE from the read-data-package …

Definition at line 382 of file msgque_overload_mq.h.

◆ MqReadBOL_C

#define MqReadBOL_C ( ...)
Value:
if (MkErrorCheckI(MqReadBOL(__VA_ARGS__)))
MqReadBOL
#define MqReadBOL(...)
Definition msgque_overload_mq.h:382

Definition at line 384 of file msgque_overload_mq.h.

◆ MqReadBOL_E

#define MqReadBOL_E ( ...)
Value:
MkErrorCheck(MqReadBOL(__VA_ARGS__))

Definition at line 383 of file msgque_overload_mq.h.

◆ MqReadBOL_e

#define MqReadBOL_e ( ...)
Value:
MK_EMBEDDED(MK_BOL,MqReadBOL,__VA_ARGS__)
MK_BOL
unsigned char MK_BOL

Definition at line 385 of file msgque_overload_mq.h.

◆ MqReadBOL_NULL

#define MqReadBOL_NULL ( ...)
Value:
MqReadBOL_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 381 of file msgque_overload_mq.h.

◆ MqReadBUF

#define MqReadBUF ( ...)
Value:
MqReadBUF_RT(MK_RT_CALL __VA_ARGS__)
MqReadBUF_RT
MQ_EXTERN enum MkErrorE MqReadBUF_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_BUF *const val_out)
get a temporary MkBufferC from the read-data-package …

Definition at line 370 of file msgque_overload_mq.h.

◆ MqReadBUF_C

#define MqReadBUF_C ( ...)
Value:
if (MkErrorCheckI(MqReadBUF(__VA_ARGS__)))
MqReadBUF
#define MqReadBUF(...)
Definition msgque_overload_mq.h:370

Definition at line 372 of file msgque_overload_mq.h.

◆ MqReadBUF_E

#define MqReadBUF_E ( ...)
Value:
MkErrorCheck(MqReadBUF(__VA_ARGS__))

Definition at line 371 of file msgque_overload_mq.h.

◆ MqReadBUF_e

#define MqReadBUF_e ( ...)
Value:
MK_EMBEDDED(MK_BUF,MqReadBUF,__VA_ARGS__)

Definition at line 373 of file msgque_overload_mq.h.

◆ MqReadBUF_NULL

#define MqReadBUF_NULL ( ...)
Value:
MqReadBUF_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 369 of file msgque_overload_mq.h.

◆ MqReadDBL

#define MqReadDBL ( ...)
Value:
MqReadDBL_RT(MK_RT_CALL __VA_ARGS__)
MqReadDBL_RT
MQ_EXTERN enum MkErrorE MqReadDBL_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_DBL *const val_out)
read a PRIMITIVE TYPE from the read-data-package …

Definition at line 392 of file msgque_overload_mq.h.

◆ MqReadDBL_C

#define MqReadDBL_C ( ...)
Value:
if (MkErrorCheckI(MqReadDBL(__VA_ARGS__)))
MqReadDBL
#define MqReadDBL(...)
Definition msgque_overload_mq.h:392

Definition at line 394 of file msgque_overload_mq.h.

◆ MqReadDBL_E

#define MqReadDBL_E ( ...)
Value:
MkErrorCheck(MqReadDBL(__VA_ARGS__))

Definition at line 393 of file msgque_overload_mq.h.

◆ MqReadDBL_e

#define MqReadDBL_e ( ...)
Value:
MK_EMBEDDED(MK_DBL,MqReadDBL,__VA_ARGS__)
MK_DBL
double MK_DBL

Definition at line 395 of file msgque_overload_mq.h.

◆ MqReadDBL_NULL

#define MqReadDBL_NULL ( ...)
Value:
MqReadDBL_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 391 of file msgque_overload_mq.h.

◆ MqReadFLT

#define MqReadFLT ( ...)
Value:
MqReadFLT_RT(MK_RT_CALL __VA_ARGS__)
MqReadFLT_RT
MQ_EXTERN enum MkErrorE MqReadFLT_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_FLT *const val_out)
read a PRIMITIVE TYPE from the read-data-package …

Definition at line 397 of file msgque_overload_mq.h.

◆ MqReadFLT_C

#define MqReadFLT_C ( ...)
Value:
if (MkErrorCheckI(MqReadFLT(__VA_ARGS__)))
MqReadFLT
#define MqReadFLT(...)
Definition msgque_overload_mq.h:397

Definition at line 399 of file msgque_overload_mq.h.

◆ MqReadFLT_E

#define MqReadFLT_E ( ...)
Value:
MkErrorCheck(MqReadFLT(__VA_ARGS__))

Definition at line 398 of file msgque_overload_mq.h.

◆ MqReadFLT_e

#define MqReadFLT_e ( ...)
Value:
MK_EMBEDDED(MK_FLT,MqReadFLT,__VA_ARGS__)
MK_FLT
float MK_FLT

Definition at line 400 of file msgque_overload_mq.h.

◆ MqReadFLT_NULL

#define MqReadFLT_NULL ( ...)
Value:
MqReadFLT_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 396 of file msgque_overload_mq.h.

◆ MqReadHDL

#define MqReadHDL ( ...)
Value:
MqReadHDL_RT(MK_RT_CALL __VA_ARGS__)
MqReadHDL_RT
MQ_EXTERN enum MkErrorE MqReadHDL_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_HDL *const val_out)
read the handle from the read-data-package

Definition at line 402 of file msgque_overload_mq.h.

◆ MqReadHDL_C

#define MqReadHDL_C ( ...)
Value:
if (MkErrorCheckI(MqReadHDL(__VA_ARGS__)))
MqReadHDL
#define MqReadHDL(...)
Definition msgque_overload_mq.h:402

Definition at line 404 of file msgque_overload_mq.h.

◆ MqReadHDL_E

#define MqReadHDL_E ( ...)
Value:
MkErrorCheck(MqReadHDL(__VA_ARGS__))

Definition at line 403 of file msgque_overload_mq.h.

◆ MqReadHDL_e

#define MqReadHDL_e ( ...)
Value:
MK_EMBEDDED(MK_HDL,MqReadHDL,__VA_ARGS__)
MK_HDL
int32_t MK_HDL

Definition at line 405 of file msgque_overload_mq.h.

◆ MqReadHDL_NULL

#define MqReadHDL_NULL ( ...)
Value:
MqReadHDL_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 401 of file msgque_overload_mq.h.

◆ MqReadI16

#define MqReadI16 ( ...)
Value:
MqReadI16_RT(MK_RT_CALL __VA_ARGS__)
MqReadI16_RT
MQ_EXTERN enum MkErrorE MqReadI16_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_I16 *const val_out)
read a PRIMITIVE TYPE from the read-data-package …

Definition at line 407 of file msgque_overload_mq.h.

◆ MqReadI16_C

#define MqReadI16_C ( ...)
Value:
if (MkErrorCheckI(MqReadI16(__VA_ARGS__)))
MqReadI16
#define MqReadI16(...)
Definition msgque_overload_mq.h:407

Definition at line 409 of file msgque_overload_mq.h.

◆ MqReadI16_E

#define MqReadI16_E ( ...)
Value:
MkErrorCheck(MqReadI16(__VA_ARGS__))

Definition at line 408 of file msgque_overload_mq.h.

◆ MqReadI16_e

#define MqReadI16_e ( ...)
Value:
MK_EMBEDDED(MK_I16,MqReadI16,__VA_ARGS__)
MK_I16
signed short int MK_I16

Definition at line 410 of file msgque_overload_mq.h.

◆ MqReadI16_NULL

#define MqReadI16_NULL ( ...)
Value:
MqReadI16_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 406 of file msgque_overload_mq.h.

◆ MqReadI32

#define MqReadI32 ( ...)
Value:
MqReadI32_RT(MK_RT_CALL __VA_ARGS__)
MqReadI32_RT
MQ_EXTERN enum MkErrorE MqReadI32_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_I32 *const val_out)
read a PRIMITIVE TYPE from the read-data-package …

Definition at line 412 of file msgque_overload_mq.h.

◆ MqReadI32_C

#define MqReadI32_C ( ...)
Value:
if (MkErrorCheckI(MqReadI32(__VA_ARGS__)))
MqReadI32
#define MqReadI32(...)
Definition msgque_overload_mq.h:412

Definition at line 414 of file msgque_overload_mq.h.

◆ MqReadI32_E

#define MqReadI32_E ( ...)
Value:
MkErrorCheck(MqReadI32(__VA_ARGS__))

Definition at line 413 of file msgque_overload_mq.h.

◆ MqReadI32_e

#define MqReadI32_e ( ...)
Value:
MK_EMBEDDED(MK_I32,MqReadI32,__VA_ARGS__)
MK_I32
signed int MK_I32

Definition at line 415 of file msgque_overload_mq.h.

◆ MqReadI32_NULL

#define MqReadI32_NULL ( ...)
Value:
MqReadI32_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 411 of file msgque_overload_mq.h.

◆ MqReadI64

#define MqReadI64 ( ...)
Value:
MqReadI64_RT(MK_RT_CALL __VA_ARGS__)
MqReadI64_RT
MQ_EXTERN enum MkErrorE MqReadI64_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_I64 *const val_out)
read a PRIMITIVE TYPE from the read-data-package …

Definition at line 417 of file msgque_overload_mq.h.

◆ MqReadI64_C

#define MqReadI64_C ( ...)
Value:
if (MkErrorCheckI(MqReadI64(__VA_ARGS__)))
MqReadI64
#define MqReadI64(...)
Definition msgque_overload_mq.h:417

Definition at line 419 of file msgque_overload_mq.h.

◆ MqReadI64_E

#define MqReadI64_E ( ...)
Value:
MkErrorCheck(MqReadI64(__VA_ARGS__))

Definition at line 418 of file msgque_overload_mq.h.

◆ MqReadI64_e

#define MqReadI64_e ( ...)
Value:
MK_EMBEDDED(MK_I64,MqReadI64,__VA_ARGS__)
MK_I64
signed long long MK_I64

Definition at line 420 of file msgque_overload_mq.h.

◆ MqReadI64_NULL

#define MqReadI64_NULL ( ...)
Value:
MqReadI64_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 416 of file msgque_overload_mq.h.

◆ MqReadI8

#define MqReadI8 ( ...)
Value:
MqReadI8_RT(MK_RT_CALL __VA_ARGS__)
MqReadI8_RT
MQ_EXTERN enum MkErrorE MqReadI8_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_I8 *const val_out)
read a PRIMITIVE TYPE from the read-data-package …

Definition at line 422 of file msgque_overload_mq.h.

◆ MqReadI8_C

#define MqReadI8_C ( ...)
Value:
if (MkErrorCheckI(MqReadI8(__VA_ARGS__)))
MqReadI8
#define MqReadI8(...)
Definition msgque_overload_mq.h:422

Definition at line 424 of file msgque_overload_mq.h.

◆ MqReadI8_E

#define MqReadI8_E ( ...)
Value:
MkErrorCheck(MqReadI8(__VA_ARGS__))

Definition at line 423 of file msgque_overload_mq.h.

◆ MqReadI8_e

#define MqReadI8_e ( ...)
Value:
MK_EMBEDDED(MK_I8,MqReadI8,__VA_ARGS__)
MK_I8
signed char MK_I8

Definition at line 425 of file msgque_overload_mq.h.

◆ MqReadI8_NULL

#define MqReadI8_NULL ( ...)
Value:
MqReadI8_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 421 of file msgque_overload_mq.h.

◆ MqReadLIST

#define MqReadLIST ( ...)
Value:
MqReadLIST_RT(MK_RT_CALL __VA_ARGS__)
MqReadLIST_RT
MQ_EXTERN enum MkErrorE MqReadLIST_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_NAT_LIST *const val_out)
get all arguments as native list …

Definition at line 427 of file msgque_overload_mq.h.

◆ MqReadLIST_C

#define MqReadLIST_C ( ...)
Value:
if (MkErrorCheckI(MqReadLIST(__VA_ARGS__)))
MqReadLIST
#define MqReadLIST(...)
Definition msgque_overload_mq.h:427

Definition at line 429 of file msgque_overload_mq.h.

◆ MqReadLIST_E

#define MqReadLIST_E ( ...)
Value:
MkErrorCheck(MqReadLIST(__VA_ARGS__))

Definition at line 428 of file msgque_overload_mq.h.

◆ MqReadLIST_e

#define MqReadLIST_e ( ...)
Value:
MK_EMBEDDED(MK_NAT_LIST,MqReadLIST,__VA_ARGS__)
MK_NAT_LIST
void * MK_NAT_LIST

Definition at line 430 of file msgque_overload_mq.h.

◆ MqReadLIST_NULL

#define MqReadLIST_NULL ( ...)
Value:
MqReadLIST_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 426 of file msgque_overload_mq.h.

◆ MqReadLONG

#define MqReadLONG ( ...)
Value:
MqReadLONG_RT(MK_RT_CALL __VA_ARGS__)
MqReadLONG_RT
MQ_EXTERN enum MkErrorE MqReadLONG_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_LONG *const val_out)
read the long native object from the read-data-package

Definition at line 432 of file msgque_overload_mq.h.

◆ MqReadLONG_C

#define MqReadLONG_C ( ...)
Value:
if (MkErrorCheckI(MqReadLONG(__VA_ARGS__)))
MqReadLONG
#define MqReadLONG(...)
Definition msgque_overload_mq.h:432

Definition at line 434 of file msgque_overload_mq.h.

◆ MqReadLONG_E

#define MqReadLONG_E ( ...)
Value:
MkErrorCheck(MqReadLONG(__VA_ARGS__))

Definition at line 433 of file msgque_overload_mq.h.

◆ MqReadLONG_e

#define MqReadLONG_e ( ...)
Value:
MK_EMBEDDED(MK_LONG,MqReadLONG,__VA_ARGS__)
MK_LONG
long MK_LONG

Definition at line 435 of file msgque_overload_mq.h.

◆ MqReadLONG_NULL

#define MqReadLONG_NULL ( ...)
Value:
MqReadLONG_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 431 of file msgque_overload_mq.h.

◆ MqReadNEXT

#define MqReadNEXT ( ...)
Value:
MqReadNEXT_RT(MK_RT_CALL __VA_ARGS__)
MqReadNEXT_RT
MQ_EXTERN enum MkErrorE MqReadNEXT_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_NAT_OBJECT *const val_out)
get the next argument as native object …

Definition at line 437 of file msgque_overload_mq.h.

◆ MqReadNEXT_C

#define MqReadNEXT_C ( ...)
Value:
if (MkErrorCheckI(MqReadNEXT(__VA_ARGS__)))
MqReadNEXT
#define MqReadNEXT(...)
Definition msgque_overload_mq.h:437

Definition at line 439 of file msgque_overload_mq.h.

◆ MqReadNEXT_E

#define MqReadNEXT_E ( ...)
Value:
MkErrorCheck(MqReadNEXT(__VA_ARGS__))

Definition at line 438 of file msgque_overload_mq.h.

◆ MqReadNEXT_e

#define MqReadNEXT_e ( ...)
Value:
MK_EMBEDDED(MK_NAT_OBJECT,MqReadNEXT,__VA_ARGS__)
MK_NAT_OBJECT
void * MK_NAT_OBJECT

Definition at line 440 of file msgque_overload_mq.h.

◆ MqReadNEXT_NULL

#define MqReadNEXT_NULL ( ...)
Value:
MqReadNEXT_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 436 of file msgque_overload_mq.h.

◆ MqReadSTR

#define MqReadSTR ( ...)
Value:
MqReadSTR_RT(MK_RT_CALL __VA_ARGS__)
MqReadSTR_RT
MQ_EXTERN enum MkErrorE MqReadSTR_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_STRN *const val_out)
read a PRIMITIVE TYPE from the read-data-package …

Definition at line 442 of file msgque_overload_mq.h.

◆ MqReadSTR_C

#define MqReadSTR_C ( ...)
Value:
if (MkErrorCheckI(MqReadSTR(__VA_ARGS__)))
MqReadSTR
#define MqReadSTR(...)
Definition msgque_overload_mq.h:442

Definition at line 444 of file msgque_overload_mq.h.

◆ MqReadSTR_E

#define MqReadSTR_E ( ...)
Value:
MkErrorCheck(MqReadSTR(__VA_ARGS__))

Definition at line 443 of file msgque_overload_mq.h.

◆ MqReadSTR_e

#define MqReadSTR_e ( ...)
Value:
MK_EMBEDDED(MK_STRN,MqReadSTR,__VA_ARGS__)
MK_STRN
const MK_STRB * MK_STRN

Definition at line 445 of file msgque_overload_mq.h.

◆ MqReadSTR_NULL

#define MqReadSTR_NULL ( ...)
Value:
MqReadSTR_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 441 of file msgque_overload_mq.h.

◆ MqReadStringR

#define MqReadStringR ( ...)
Value:
MqReadStringR_RT(MK_RT_CALL __VA_ARGS__)
MqReadStringR_RT
MQ_EXTERN enum MkErrorE MqReadStringR_RT(MK_RT const mkrt, MQ_CTX const ctx, MkStringR *const val_out)
read a MkStringR from the read-data-package …

Definition at line 447 of file msgque_overload_mq.h.

◆ MqReadStringR_C

#define MqReadStringR_C ( ...)
Value:
if (MkErrorCheckI(MqReadStringR(__VA_ARGS__)))
MqReadStringR
#define MqReadStringR(...)
Definition msgque_overload_mq.h:447

Definition at line 449 of file msgque_overload_mq.h.

◆ MqReadStringR_E

#define MqReadStringR_E ( ...)
Value:
MkErrorCheck(MqReadStringR(__VA_ARGS__))

Definition at line 448 of file msgque_overload_mq.h.

◆ MqReadStringR_e

#define MqReadStringR_e ( ...)
Value:
MK_EMBEDDED_REF(MkStringR,MqReadStringR,__VA_ARGS__)

Definition at line 450 of file msgque_overload_mq.h.

◆ MqReadStringR_NULL

#define MqReadStringR_NULL ( ...)
Value:
MqReadStringR_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 446 of file msgque_overload_mq.h.

Function Documentation

◆ MqReadALL_RT()

MQ_EXTERN enum MkErrorE MqReadALL_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_BFL *const val_inout )

get a temporary MkBufferListC from all data in the read-data-package …

If the val_inout is None than a temporary MkBufferListC is returned. If the val_inout is not None than the memory of the val_inout is reused.

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
[out]val_inoutthe MkBufferListC - the storage of the input is reused
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
See also
MqReadBFL
Attention
(do not free) The memory of the out/return value belongs to the called PythonMqMsgque function and therefore never becomes None for a non-error result.
For details on the out/return value, see: MkKernel_Storage_C_API.

◆ MqReadBFL_RT()

MQ_EXTERN enum MkErrorE MqReadBFL_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_BFL *const val_out )

get a temporary MkBufferListC from next list-item in the read-data-package …

If the next item in the read-data-package is a list-item, (created with MqReadL_START and ctx.ReadL_END()), only return this item. If the next item in the read-data-package is not a list-item than return an error. If you require all data in the read-data-package returned as single MkBufferListC than use MqReadALL.

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
[out]val_outthe MkBufferListC as return-value
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
See also
MqReadALL
Attention
(do not free) The memory of the out/return value belongs to the called PythonMqMsgque function and therefore never becomes None for a non-error result.
For details on the out/return value, see: MkKernel_Storage_C_API.

◆ MqReadBIN_RT()

MQ_EXTERN enum MkErrorE MqReadBIN_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MkBinaryR *const val_out )

generic function to read an MK_BIN object from the read-data-package object …

The object returned is owned by the read-data-package and is only valid up to the next call of any MqContextC READ API function. If a long-term object is required the string have-to-be duplicated.

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
[out]val_outthe MkBinaryR data to return
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Attention
The val_out returned is a pointer to the internal read-data-package memory. Using this pointer to write into the read-data-package memory… example: MqDumpImport … result in a Source and destination overlap in memcpy error.
Using this pointer to write into the send-data-package memory… is no problem.
read more at MkKernel_Storage_C_API.
In general MkBinaryR is owned by the called function, to get your own copy use MkBinaryDup.

◆ MqReadBinaryR_RT()

MQ_EXTERN enum MkErrorE MqReadBinaryR_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MkBinaryR *const val_out )

read a MkBinaryR 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
[out]val_outthe MkBinaryR to return
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

MqSendSTR

◆ MqReadBOL_RT()

MQ_EXTERN enum MkErrorE MqReadBOL_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_BOL *const val_out )

read a PRIMITIVE TYPE 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
[out]val_outthe value to read
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqReadBUF_RT()

MQ_EXTERN enum MkErrorE MqReadBUF_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_BUF *const val_out )

get a temporary MkBufferC from the read-data-package …

Return a temporary-data-item from the read-data-package. The lifetime of the MkBufferC is only the current callback up to the next read operation in the same parent-context. This object is owned by PythonMqMsgque and must not be freed.

Example from server.py → read and update a MkBufferC 

      # ReadBUF - Example, read a buffer-object and append a string
      buf = self.ReadBUF()
      buf.AppendSTR("- a really log text to overwrite the already allocated space")
      self.SendBUF(buf)
      self.SendI32(self.ReadI32()+1)
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
[out]val_outThe out-value of type MkBufferC. 1) It is an error if the out-value is None, 2. If there is an error, the out-value remains unchanged.
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Error Messages
  1. if ctx is None
  2. if ctx is not connected
  3. if val_out is null
  4. if are no items to return
  5. if the data-package is corrupt
Attention
(do not free) The memory of the out/return value belongs to the called PythonMqMsgque function and therefore never becomes None for a non-error result.
For details on the out/return value, see: MkKernel_Storage_C_API.

◆ MqReadDBL_RT()

MQ_EXTERN enum MkErrorE MqReadDBL_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_DBL *const val_out )

read a PRIMITIVE TYPE 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
[out]val_outthe value to read
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqReadFLT_RT()

MQ_EXTERN enum MkErrorE MqReadFLT_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_FLT *const val_out )

read a PRIMITIVE TYPE 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
[out]val_outthe value to read
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqReadHDL_RT()

MQ_EXTERN enum MkErrorE MqReadHDL_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_HDL *const val_out )

read the handle from the read-data-package

See also
MqSendHDL, MK_HDL
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
[out]val_outthe handle-object to read
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Attention
this is NON portable

◆ MqReadI16_RT()

MQ_EXTERN enum MkErrorE MqReadI16_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_I16 *const val_out )

read a PRIMITIVE TYPE 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
[out]val_outthe value to read
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqReadI32_RT()

MQ_EXTERN enum MkErrorE MqReadI32_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_I32 *const val_out )

read a PRIMITIVE TYPE 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
[out]val_outthe value to read
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqReadI64_RT()

MQ_EXTERN enum MkErrorE MqReadI64_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_I64 *const val_out )

read a PRIMITIVE TYPE 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
[out]val_outthe value to read
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqReadI8_RT()

MQ_EXTERN enum MkErrorE MqReadI8_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_I8 *const val_out )

read a PRIMITIVE TYPE 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
[out]val_outthe value to read
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqReadLIST_RT()

MQ_EXTERN enum MkErrorE MqReadLIST_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_NAT_LIST *const val_out )

get all arguments as native list …

The MqReadLIST is a function what interacts with the Target-Programming-Language (TPL) list-object.

There is no guarantee that a list-object will be available. Therefore, this function is an add-on and will only be implemented when possible.

Example from example/tcl/server.tcl → start a WORKER using all arguments from the service-call.

# start worker with arguments from the service-call using the current executable
my SlaveWorker $id "WORKER" {*}[my ReadLIST] --name wk-cl-$id @ --name wk-sv-$id
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
[out]val_outthe native list as return
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
See also
MqReadBFL MqReadNEXT

◆ MqReadLONG_RT()

MQ_EXTERN enum MkErrorE MqReadLONG_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_LONG *const val_out )

read the long native object from the read-data-package

on 64bit use a MqReadI64 and on 32bit use a MqReadI32

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
[out]val_outthe native long object to read
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Attention
this is NON portable

◆ MqReadNEXT_RT()

MQ_EXTERN enum MkErrorE MqReadNEXT_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_NAT_OBJECT *const val_out )

get the next argument as native object …

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
[out]val_outthe native object as return
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
See also
MqReadLIST MqReadBUF

◆ MqReadSTR_RT()

MQ_EXTERN enum MkErrorE MqReadSTR_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_STRN *const val_out )

read a PRIMITIVE TYPE from the read-data-package …

The object returned is owned by the read-data-package and is only valid up to the next call of any MqContextC READ API function. If a long-term object is required the string have-to-be duplicated.

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
[out]val_outthe string to return
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

MqReadStringR

MqSendSTR

◆ MqReadStringR_RT()

MQ_EXTERN enum MkErrorE MqReadStringR_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MkStringR *const val_out )

read a MkStringR 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
[out]val_outthe MkStringR to return
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

MqSendSTR

Generated on Wed Sep 25 2024 12:15:48 for theLink by doxygen 1.13.0