Loading...
Searching...
No Matches
MqContextC_Class_Define_C_API

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

+ Collaboration diagram for MqContextC_Class_Define_C_API:

MqContextC - type definition

typedef struct MqContextS MqContextCR
 instance-struct-reference same as struct MqContextS, useable in a class-macro as: class##R
 
typedef const struct MqContextS MqContextCNR
 const instance-struct-reference same as const struct MqContextS, useable in a class-macro as: class##R
 
#define MqContextC_T   (&MQ_RT_REF._MqContextC_T)
 class as MqCtxTypeS-class-type, useable in a class-macro as: class##_T
 
#define MqContextC_TT   (MkTYP(MqContextC_T))
 class as MkTypeS-class-type, useable in a class-macro as: class##_TT
 
#define MqContextST   MqContextC_T
 instance-type as MqCtxTypeS-class-type …
 
#define MqContextSTT   (MkTYP(MqContextST))
 instance-type as MkTypeS-class-type (cast from MqContextST into MkTypeS) …
 
#define MqContextC_type   MQ_CTX
 same as MqContextS but useable in a class-macro as: class##_type
 
#define MqContextCT_X(instance)
 cast from an instance into the MqCtxTypeS-class-type …
 
#define MqContextCTT_X(instance)
 cast from an instance into the MkTypeS-class-type …
 
#define MqContextCT_TT(typ)
 cast from an MkTypeS-class-type into an MqCtxTypeS-class-type …
 
#define MqContextC_NS   MQ
 map class to namespace …
 
#define MqContextCTT   MqContextCTT
 class as MkTypeS-class-type for MqContextC in the Target-Programming-Language (TPL)
 
#define MqContextCT   ( (struct MqCtxTypeS *) MqContextCTT )
 class as MqCtxTypeS-class-type for MqContextC in the Target-Programming-Language (TPL)
 

MqContextC - signature check

bool MqCtxCheck (MK_MNGN mng)
 check MqContextS -> MkObjectS::signature
 
bool MqCtxCheckO (MK_OBJN obj)
 check MqContextS -> MkObjectS::signature
 
#define MqContextC_Check(mng)
 

MqContextC - cast from a defined or a undefined instance

MQ_CTX MqCtx (MK_MNG mng)
 cast a unknown-object into an MqContextS pointer or NULL if not possible
 
MQ_CTXN MqCtxN (MK_MNGN mng)
 (const) cast a unknown-object into an MqContextS pointer or NULL if not possible
 
#define MqCtxRaise(_ctx)
 raise an error if class-instance is not valid
 
#define MqCTX_R(x)
 cast a known-object into an MqContextS reference
 
#define MqCTX(x)
 cast a known-object into an MqContextS pointer
 

MqContextC - MqContextC_Class_Define_C_API - function

MQ_CTX MqCtxP (MK_MNG mng)
 Non-inline replacement for MqCtx
 
MK_BOOL MqCtxCheckP (MK_MNGN mng)
 Non-inline replacement for MqCtxCheck
 
MK_BOOL MqCtxCheckOP (MK_OBJN obj)
 Non-inline replacement for MqCtxCheckO
 
MQ_CTXN MqCtxNP (MK_MNGN mng)
 Non-inline replacement for MqCtxN
 

MqContextC - signature define

#define MqContextC_SIGNATURE   (MkObjectC_SIGNATURE ^ (11u<<10))
 
#define MqContextC_MASK   (((1u<<22)-1)<<10)
 

MqContextC - cast to superclass

#define MqContextC_X2ctx(x)
 
#define MqContextC_X2obj(x)
 

Detailed Description

MqContextC - low level definition, access and cast …

Macro Definition Documentation

◆ MqContextC_Check

#define MqContextC_Check ( mng)
Value:
bool MqCtxCheck(MK_MNGN mng)
check MqContextS -> MkObjectS::signature …

Definition at line 4103 of file LibMqMsgque_mq.h.

◆ MqContextC_MASK

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

Definition at line 4033 of file LibMqMsgque_mq.h.

◆ MqContextC_NS

#define MqContextC_NS   MQ

map class to namespace …

Definition at line 4072 of file LibMqMsgque_mq.h.

◆ MqContextC_SIGNATURE

#define MqContextC_SIGNATURE   (MkObjectC_SIGNATURE ^ (11u<<10))

Definition at line 4032 of file LibMqMsgque_mq.h.

◆ MqContextC_T

#define MqContextC_T   (&MQ_RT_REF._MqContextC_T)

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

Definition at line 4056 of file LibMqMsgque_mq.h.

◆ MqContextC_TT

#define MqContextC_TT   (MkTYP(MqContextC_T))

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

Definition at line 4058 of file LibMqMsgque_mq.h.

◆ MqContextC_type

#define MqContextC_type   MQ_CTX

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

Definition at line 4064 of file LibMqMsgque_mq.h.

◆ MqContextC_X2ctx

#define MqContextC_X2ctx ( x)
Value:
(x)

Definition at line 4041 of file LibMqMsgque_mq.h.

◆ MqContextC_X2obj

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

Definition at line 4042 of file LibMqMsgque_mq.h.

◆ MqContextCT

#define MqContextCT   ( (struct MqCtxTypeS *) MqContextCTT )

class as MqCtxTypeS-class-type for MqContextC in the Target-Programming-Language (TPL)

Definition at line 4076 of file LibMqMsgque_mq.h.

◆ MqContextCT_TT

#define MqContextCT_TT ( typ)
Value:
( (struct MqCtxTypeS *) (typ) )
MqCtxTypeS - the instance-base for the MqContextC …
struct MkTypeS typ

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

Definition at line 4070 of file LibMqMsgque_mq.h.

◆ MqContextCT_X

#define MqContextCT_X ( instance)
Value:
( (struct MqCtxTypeS *) (MkOBJ_R(instance).type) )
#define MkOBJ_R(x)

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

Definition at line 4066 of file LibMqMsgque_mq.h.

◆ MqContextCTT

#define MqContextCTT   MqContextCTT

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

Definition at line 4074 of file LibMqMsgque_mq.h.

◆ MqContextCTT_X

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

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

Definition at line 4068 of file LibMqMsgque_mq.h.

◆ MqContextST

#define MqContextST   MqContextC_T

instance-type as MqCtxTypeS-class-type …

Definition at line 4060 of file LibMqMsgque_mq.h.

◆ MqContextSTT

#define MqContextSTT   (MkTYP(MqContextST))

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

Definition at line 4062 of file LibMqMsgque_mq.h.

◆ MqCTX

#define MqCTX ( x)
Value:
(&MqCTX_R(x))
#define MqCTX_R(x)
cast a known-object into an MqContextS reference

cast a known-object into an MqContextS pointer

Definition at line 4135 of file LibMqMsgque_mq.h.

◆ MqCTX_R

#define MqCTX_R ( x)
Value:
(*(x)).super.ctx

cast a known-object into an MqContextS reference

Definition at line 4133 of file LibMqMsgque_mq.h.

◆ MqCtxRaise

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

raise an error if class-instance is not valid

Definition at line 4127 of file LibMqMsgque_mq.h.

4127 #define MqCtxRaise(_ctx) if (!_MkCheckX(MqContextC,_ctx)) { \
4128 MkErrorSetC_1E("'MqContextC' hdl is NULL"); \
4129 goto error ; \
4130 }

Typedef Documentation

◆ MqContextCNR

typedef const struct MqContextS MqContextCNR

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

Definition at line 4054 of file LibMqMsgque_mq.h.

◆ MqContextCR

typedef struct MqContextS MqContextCR

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

Definition at line 4052 of file LibMqMsgque_mq.h.

Function Documentation

◆ MqCtx()

MQ_CTX MqCtx ( MK_MNG mng)
inline

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

Definition at line 4115 of file LibMqMsgque_mq.h.

4115 {
4116 return (MqCtxCheck(mng) ? (MQ_CTX)mng : NULL);
4117 }
PUBLIC data structure for the pymqmsgque-specific-data
+ Here is the caller graph for this function:

◆ MqCtxCheck()

bool MqCtxCheck ( MK_MNGN mng)
inline

check MqContextS -> MkObjectS::signature

Returns
TRUE on valid ctx and FALSE an invalid ctx

Definition at line 4091 of file LibMqMsgque_mq.h.

4091 {
4092 return MkSanitizeCheck(MqContextC,mng);
4093 }
#define MkSanitizeCheck(_root, _m)
+ Here is the caller graph for this function:

◆ MqCtxCheckO()

bool MqCtxCheckO ( MK_OBJN obj)
inline

check MqContextS -> MkObjectS::signature

Returns
TRUE on valid ctx and FALSE an invalid ctx

Definition at line 4098 of file LibMqMsgque_mq.h.

4098 {
4099 return MkSanitizeCheckO(MqContextC,obj);
4100 }
#define MkSanitizeCheckO(_root, _o)

◆ MqCtxCheckOP()

MK_BOOL MqCtxCheckOP ( MK_OBJN obj)
extern

Non-inline replacement for MqCtxCheckO

◆ MqCtxCheckP()

MK_BOOL MqCtxCheckP ( MK_MNGN mng)
extern

Non-inline replacement for MqCtxCheck

◆ MqCtxN()

MQ_CTXN MqCtxN ( MK_MNGN mng)
inline

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

Definition at line 4122 of file LibMqMsgque_mq.h.

4122 {
4123 return (MqCtxCheck(mng) ? (MQ_CTXN)mng : NULL);
4124 }

◆ MqCtxNP()

MQ_CTXN MqCtxNP ( MK_MNGN mng)
extern

Non-inline replacement for MqCtxN

◆ MqCtxP()

MQ_CTX MqCtxP ( MK_MNG mng)
extern

Non-inline replacement for MqCtx