theLink 10.0
Loading...
Searching...
No Matches
MqDumpC_Class_Define_C_API

MqDumpC - low level definition, access and cast … More...

+ Collaboration diagram for MqDumpC_Class_Define_C_API:

MqDumpC - type definition

typedef struct MqDumpS MqDumpCR
 instance-struct-reference same as struct MqDumpS, useable in a class-macro as: class##R
 
typedef const struct MqDumpS MqDumpCNR
 const instance-struct-reference same as const struct MqDumpS, useable in a class-macro as: class##R
 
#define MqDumpC_T   (&MQ_RT_REF._MqDumpC_T)
 class as MkTypeDefS-class-type, useable in a class-macro as: class##_T
 
#define MqDumpC_TT   (MkTYP(MqDumpC_T))
 class as MkTypeS-class-type, useable in a class-macro as: class##_TT
 
#define MqDumpST   MqDumpC_T
 instance-type as MkTypeDefS-class-type …
 
#define MqDumpSTT   (MkTYP(MqDumpST))
 instance-type as MkTypeS-class-type (cast from MqDumpST into MkTypeS) …
 
#define MqDumpC_type   MQ_DMP
 same as MqDumpS but useable in a class-macro as: class##_type
 
#define MqDumpCT_X(instance)
 cast from an instance into the MkTypeDefS-class-type …
 
#define MqDumpCTT_X(instance)
 cast from an instance into the MkTypeS-class-type …
 
#define MqDumpCT_TT(typ)
 cast from an MkTypeS-class-type into an MkTypeDefS-class-type …
 
#define MqDumpC_NS   MQ
 map class to namespace …
 
#define MqDumpCTT   MqDumpCTT
 class as MkTypeS-class-type for MqDumpC in the Target-Programming-Language (TPL)
 
#define MqDumpCT   ( (struct MkTypeDefS *) MqDumpCTT )
 class as MkTypeDefS-class-type for MqDumpC in the Target-Programming-Language (TPL)
 

MqDumpC - signature check

static bool MqDmpCheck (MK_MNGN mng)
 check MqDumpS -> MkObjectS::signature
 
static bool MqDmpCheckO (MK_OBJN obj)
 check MqDumpS -> MkObjectS::signature
 
#define MqDumpC_Check(mng)
 

MqDumpC - cast from a defined or a undefined instance

static MQ_DMP MqDmp (MK_MNG mng)
 cast a unknown-object into an MqDumpS pointer or NULL if not possible
 
static MQ_DMPN MqDmpN (MK_MNGN mng)
 (const) cast a unknown-object into an MqDumpS pointer or NULL if not possible
 
#define MqDmpRaise(_dmp)
 raise an error if class-instance is not valid
 
#define MqDMP_R(x)
 cast a known-object into an MqDumpS reference
 
#define MqDMP(x)
 cast a known-object into an MqDumpS pointer
 

MqDumpC - MqDumpC_Class_Define_C_API - function

MQ_DMP MqDmpP (MK_MNG mng)
 Non-inline replacement for MqDmp
 
MK_BOOL MqDmpCheckP (MK_MNGN mng)
 Non-inline replacement for MqDmpCheck
 
MK_BOOL MqDmpCheckOP (MK_OBJN obj)
 Non-inline replacement for MqDmpCheckO
 
MQ_DMPN MqDmpNP (MK_MNGN mng)
 Non-inline replacement for MqDmpN
 

MqDumpC - signature define

#define MqDumpC_SIGNATURE   (MkObjectC_SIGNATURE ^ (14u<<10))
 
#define MqDumpC_MASK   (((1u<<22)-1)<<10)
 

MqDumpC - cast to superclass

#define MqDumpC_X2dmp(x)
 
#define MqDumpC_X2obj(x)
 

Detailed Description

MqDumpC - low level definition, access and cast …

Macro Definition Documentation

◆ MqDMP

#define MqDMP ( x)
Value:
(&MqDMP_R(x))
#define MqDMP_R(x)
cast a known-object into an MqDumpS reference

cast a known-object into an MqDumpS pointer

Definition at line 8791 of file LibMqMsgque_mq.h.

◆ MqDMP_R

#define MqDMP_R ( x)
Value:
(*(x)).super.dmp

cast a known-object into an MqDumpS reference

Definition at line 8789 of file LibMqMsgque_mq.h.

◆ MqDmpRaise

#define MqDmpRaise ( _dmp)
Value:
if (!_MkCheckX(MqDumpC,_dmp)) { \
MkErrorSetC_1E("'MqDumpC' hdl is NULL"); \
goto error ; \
}
#define _MkCheckX(cls, x)

raise an error if class-instance is not valid

Definition at line 8783 of file LibMqMsgque_mq.h.

8783 #define MqDmpRaise(_dmp) if (!_MkCheckX(MqDumpC,_dmp)) { \
8784 MkErrorSetC_1E("'MqDumpC' hdl is NULL"); \
8785 goto error ; \
8786 }

◆ MqDumpC_Check

#define MqDumpC_Check ( mng)
Value:
static bool MqDmpCheck(MK_MNGN mng)
check MqDumpS -> MkObjectS::signature …

Definition at line 8758 of file LibMqMsgque_mq.h.

◆ MqDumpC_MASK

#define MqDumpC_MASK   (((1u<<22)-1)<<10)

Definition at line 8688 of file LibMqMsgque_mq.h.

◆ MqDumpC_NS

#define MqDumpC_NS   MQ

map class to namespace …

Definition at line 8726 of file LibMqMsgque_mq.h.

◆ MqDumpC_SIGNATURE

#define MqDumpC_SIGNATURE   (MkObjectC_SIGNATURE ^ (14u<<10))

Definition at line 8687 of file LibMqMsgque_mq.h.

◆ MqDumpC_T

#define MqDumpC_T   (&MQ_RT_REF._MqDumpC_T)

class as MkTypeDefS-class-type, useable in a class-macro as: class##_T

Definition at line 8710 of file LibMqMsgque_mq.h.

◆ MqDumpC_TT

#define MqDumpC_TT   (MkTYP(MqDumpC_T))

class as MkTypeS-class-type, useable in a class-macro as: class##_TT

Definition at line 8712 of file LibMqMsgque_mq.h.

◆ MqDumpC_type

#define MqDumpC_type   MQ_DMP

same as MqDumpS but useable in a class-macro as: class##_type

Definition at line 8718 of file LibMqMsgque_mq.h.

◆ MqDumpC_X2dmp

#define MqDumpC_X2dmp ( x)
Value:
(x)

Definition at line 8696 of file LibMqMsgque_mq.h.

◆ MqDumpC_X2obj

#define MqDumpC_X2obj ( x)
Value:
#define MkOBJ(x)

Definition at line 8697 of file LibMqMsgque_mq.h.

◆ MqDumpCT

#define MqDumpCT   ( (struct MkTypeDefS *) MqDumpCTT )

class as MkTypeDefS-class-type for MqDumpC in the Target-Programming-Language (TPL)

Definition at line 8730 of file LibMqMsgque_mq.h.

◆ MqDumpCT_TT

#define MqDumpCT_TT ( typ)
Value:
( (struct MkTypeDefS *) (typ) )
struct MkTypeS typ

cast from an MkTypeS-class-type into an MkTypeDefS-class-type …

Definition at line 8724 of file LibMqMsgque_mq.h.

◆ MqDumpCT_X

#define MqDumpCT_X ( instance)
Value:
( (struct MkTypeDefS *) (MkOBJ_R(instance).type) )
#define MkOBJ_R(x)

cast from an instance into the MkTypeDefS-class-type …

Definition at line 8720 of file LibMqMsgque_mq.h.

◆ MqDumpCTT

#define MqDumpCTT   MqDumpCTT

class as MkTypeS-class-type for MqDumpC in the Target-Programming-Language (TPL)

Definition at line 8728 of file LibMqMsgque_mq.h.

◆ MqDumpCTT_X

#define MqDumpCTT_X ( instance)
Value:
(MkOBJ_R(instance).type)

cast from an instance into the MkTypeS-class-type …

Definition at line 8722 of file LibMqMsgque_mq.h.

◆ MqDumpST

#define MqDumpST   MqDumpC_T

instance-type as MkTypeDefS-class-type …

Definition at line 8714 of file LibMqMsgque_mq.h.

◆ MqDumpSTT

#define MqDumpSTT   (MkTYP(MqDumpST))

instance-type as MkTypeS-class-type (cast from MqDumpST into MkTypeS) …

Definition at line 8716 of file LibMqMsgque_mq.h.

Typedef Documentation

◆ MqDumpCNR

typedef const struct MqDumpS MqDumpCNR

const instance-struct-reference same as const struct MqDumpS, useable in a class-macro as: class##R

Definition at line 8708 of file LibMqMsgque_mq.h.

◆ MqDumpCR

typedef struct MqDumpS MqDumpCR

instance-struct-reference same as struct MqDumpS, useable in a class-macro as: class##R

Definition at line 8706 of file LibMqMsgque_mq.h.

Function Documentation

◆ MqDmp()

static MQ_DMP MqDmp ( MK_MNG mng)
inlinestatic

cast a unknown-object into an MqDumpS pointer or NULL if not possible

Definition at line 8770 of file LibMqMsgque_mq.h.

8770 {
8771 return (MqDmpCheck(mng) ? (MQ_DMP)mng : NULL);
8772 }
MqDumpC - the class known as dmp or dump is used to export a libmqmsgque data package as binary …
+ Here is the caller graph for this function:

◆ MqDmpCheck()

static bool MqDmpCheck ( MK_MNGN mng)
inlinestatic

check MqDumpS -> MkObjectS::signature

Returns
TRUE on valid dmp and FALSE an invalid dmp

Definition at line 8745 of file LibMqMsgque_mq.h.

8745 {
8746 return MkSanitizeCheck(MqDumpC,mng);
8747 }
#define MkSanitizeCheck(_root, _m)
+ Here is the caller graph for this function:

◆ MqDmpCheckO()

static bool MqDmpCheckO ( MK_OBJN obj)
inlinestatic

check MqDumpS -> MkObjectS::signature

Returns
TRUE on valid dmp and FALSE an invalid dmp

Definition at line 8753 of file LibMqMsgque_mq.h.

8753 {
8754 return MkSanitizeCheckO(MqDumpC,obj);
8755 }
#define MkSanitizeCheckO(_root, _o)

◆ MqDmpCheckOP()

MK_BOOL MqDmpCheckOP ( MK_OBJN obj)

Non-inline replacement for MqDmpCheckO

◆ MqDmpCheckP()

MK_BOOL MqDmpCheckP ( MK_MNGN mng)

Non-inline replacement for MqDmpCheck

◆ MqDmpN()

static MQ_DMPN MqDmpN ( MK_MNGN mng)
inlinestatic

(const) cast a unknown-object into an MqDumpS pointer or NULL if not possible

Definition at line 8778 of file LibMqMsgque_mq.h.

8778 {
8779 return (MqDmpCheck(mng) ? (MQ_DMPN)mng : NULL);
8780 }

◆ MqDmpNP()

MQ_DMPN MqDmpNP ( MK_MNGN mng)

Non-inline replacement for MqDmpN

◆ MqDmpP()

MQ_DMP MqDmpP ( MK_MNG mng)

Non-inline replacement for MqDmp