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	libmqmsgque::MqContextCR
	instance-struct-reference same as struct MqContextS, useable in a class-macro as: class##R …
typedef const struct MqContextS	libmqmsgque::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	libmqmsgque::MqCtxCheck (MK_MNGN mng)
	check MqContextS -> libmkkernel::MkObjectS::signature …
bool	libmqmsgque::MqCtxCheckO (MK_OBJN obj)
	check MqContextS -> libmkkernel::MkObjectS::signature …
#define	MqContextC_Check(mng)

MqContextC - cast from a defined or a undefined instance
MQ_CTX	libmqmsgque::MqCtx (MK_MNG mng)
	cast a unknown-object into an MqContextS pointer or NULL if not possible
MQ_CTXN	libmqmsgque::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 - 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:

MqCtxCheck(mng)

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:

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) )

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) )

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))

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 ; \
  }

raise an error if class-instance is not valid

Definition at line 4127 of file LibMqMsgque_mq.h.

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

Typedef Documentation

MqContextCNR

typedef const struct MqContextS libmqmsgque::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 libmqmsgque::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 libmqmsgque::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.

                                     {
    return (MqCtxCheck(mng) ? (MQ_CTX)mng : NULL);
  }

Here is the caller graph for this function:

MqCtxCheck()

bool libmqmsgque::MqCtxCheck ( MK_MNGN mng )

inline

check MqContextS -> libmkkernel::MkObjectS::signature …

Returns

TRUE on valid ctx and FALSE an invalid ctx

Definition at line 4091 of file LibMqMsgque_mq.h.

                                          {
    return MkSanitizeCheck(MqContextC,mng);
  }

Here is the caller graph for this function:

MqCtxCheckO()

bool libmqmsgque::MqCtxCheckO ( MK_OBJN obj )

inline

check MqContextS -> libmkkernel::MkObjectS::signature …

Returns

TRUE on valid ctx and FALSE an invalid ctx

Definition at line 4098 of file LibMqMsgque_mq.h.

                                           {
    return MkSanitizeCheckO(MqContextC,obj);
  }

MqCtxN()

MQ_CTXN libmqmsgque::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.

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