MqEnvC_Class_Define_C_API

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

Collaboration diagram for MqEnvC_Class_Define_C_API:

MqEnvC - type definition
typedef struct MqEnvS	MqEnvCR
	instance-struct-reference same as struct MqEnvS, useable in a class-macro as: class##R …
typedef const struct MqEnvS	MqEnvCNR
	const instance-struct-reference same as const struct MqEnvS, useable in a class-macro as: class##R …
#define	MqEnvC_T   (&MQ_RT_REF._MqEnvC_T)
	class as MkTypeDefS-class-type, useable in a class-macro as: class##_T …
#define	MqEnvC_TT   (MkTYP(MqEnvC_T))
	class as MkTypeS-class-type, useable in a class-macro as: class##_TT …
#define	MqEnvST   MqEnvC_T
	instance-type as MkTypeDefS-class-type …
#define	MqEnvSTT   (MkTYP(MqEnvST))
	instance-type as MkTypeS-class-type (cast from MqEnvST into MkTypeS) …
#define	MqEnvC_type   MQ_ENV
	same as MqEnvS but useable in a class-macro as: class##_type …
#define	MqEnvCT_X(instance)
	cast from an instance into the MkTypeDefS-class-type …
#define	MqEnvCTT_X(instance)
	cast from an instance into the MkTypeS-class-type …
#define	MqEnvCT_TT(typ)
	cast from an MkTypeS-class-type into an MkTypeDefS-class-type …
#define	MqEnvC_NS   MQ
	map class to namespace …
#define	MqEnvCTT   MqEnvCTT
	class as MkTypeS-class-type for MqEnvC in the Target-Programming-Language (TPL) …
#define	MqEnvCT   ( (struct MkTypeDefS *) MqEnvCTT )
	class as MkTypeDefS-class-type for MqEnvC in the Target-Programming-Language (TPL) …

MqEnvC - signature check
static bool	MqEnvCheck (MK_MNGN mng)
	check MqEnvS -> MkObjectS::signature …
static bool	MqEnvCheckO (MK_OBJN obj)
	check MqEnvS -> MkObjectS::signature …
#define	MqEnvC_Check(mng)

MqEnvC - cast from a defined or a undefined instance
static MQ_ENV	MqEnv (MK_MNG mng)
	cast a unknown-object into an MqEnvS pointer or NULL if not possible
static MQ_ENVN	MqEnvN (MK_MNGN mng)
	(const) cast a unknown-object into an MqEnvS pointer or NULL if not possible
#define	MqEnvRaise(_env)
	raise an error if class-instance is not valid
#define	MqENV_R(x)
	cast a known-object into an MqEnvS reference
#define	MqENV(x)
	cast a known-object into an MqEnvS pointer

MqEnvC - signature define
#define	MqEnvC_SIGNATURE   (MkObjectC_SIGNATURE ^ (15u<<10))
#define	MqEnvC_MASK   (((1u<<22)-1)<<10)

MqEnvC - cast to superclass
#define	MqEnvC_X2env(x)
#define	MqEnvC_X2obj(x)

Detailed Description

MqEnvS - low level definition, access and cast …

Macro Definition Documentation

MqENV

#define MqENV

(

x

)

Value:

(&MqENV_R(x))

cast a known-object into an MqEnvS pointer

Definition at line 912 of file LibMqMsgque_mq.h.

MqENV_R

#define MqENV_R

(

x

)

Value:

(*(x)).super.env

cast a known-object into an MqEnvS reference

Definition at line 910 of file LibMqMsgque_mq.h.

MqEnvC_Check

#define MqEnvC_Check

(

mng

)

Value:

MqEnvCheck(mng)

Definition at line 879 of file LibMqMsgque_mq.h.

MqEnvC_MASK

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

Definition at line 809 of file LibMqMsgque_mq.h.

MqEnvC_NS

#define MqEnvC_NS   MQ

map class to namespace …

Definition at line 847 of file LibMqMsgque_mq.h.

MqEnvC_SIGNATURE

#define MqEnvC_SIGNATURE   (MkObjectC_SIGNATURE ^ (15u<<10))

Definition at line 808 of file LibMqMsgque_mq.h.

MqEnvC_T

#define MqEnvC_T   (&MQ_RT_REF._MqEnvC_T)

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

Definition at line 831 of file LibMqMsgque_mq.h.

MqEnvC_TT

#define MqEnvC_TT   (MkTYP(MqEnvC_T))

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

Definition at line 833 of file LibMqMsgque_mq.h.

MqEnvC_type

#define MqEnvC_type   MQ_ENV

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

Definition at line 839 of file LibMqMsgque_mq.h.

MqEnvC_X2env

#define MqEnvC_X2env

(

x

)

Value:

(x)

Definition at line 817 of file LibMqMsgque_mq.h.

MqEnvC_X2obj

#define MqEnvC_X2obj

(

x

)

Value:

MkOBJ(x)

Definition at line 818 of file LibMqMsgque_mq.h.

MqEnvCT

#define MqEnvCT   ( (struct MkTypeDefS *) MqEnvCTT )

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

Definition at line 851 of file LibMqMsgque_mq.h.

MqEnvCT_TT

#define MqEnvCT_TT

(

typ

)

Value:

( (struct MkTypeDefS *) (typ) )

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

Definition at line 845 of file LibMqMsgque_mq.h.

MqEnvCT_X

#define MqEnvCT_X

(

instance

)

Value:

( (struct MkTypeDefS *) (MkOBJ_R(instance).type) )

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

Definition at line 841 of file LibMqMsgque_mq.h.

MqEnvCTT

#define MqEnvCTT   MqEnvCTT

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

Definition at line 849 of file LibMqMsgque_mq.h.

MqEnvCTT_X

#define MqEnvCTT_X

(

instance

)

Value:

(MkOBJ_R(instance).type)

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

Definition at line 843 of file LibMqMsgque_mq.h.

MqEnvRaise

#define MqEnvRaise

(

_env

)

Value:

    if (!_MkCheckX(MqEnvC,_env)) { \
    MkErrorSetC_1E("'MqEnvC' hdl is NULL"); \
    goto error ; \
  }

raise an error if class-instance is not valid

Definition at line 904 of file LibMqMsgque_mq.h.

  #define MqEnvRaise(_env) if (!_MkCheckX(MqEnvC,_env)) { \
    MkErrorSetC_1E("'MqEnvC' hdl is NULL"); \
    goto error ; \
  }

MqEnvST

#define MqEnvST   MqEnvC_T

instance-type as MkTypeDefS-class-type …

Definition at line 835 of file LibMqMsgque_mq.h.

MqEnvSTT

#define MqEnvSTT   (MkTYP(MqEnvST))

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

Definition at line 837 of file LibMqMsgque_mq.h.

Typedef Documentation

MqEnvCNR

typedef const struct MqEnvS MqEnvCNR

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

Definition at line 829 of file LibMqMsgque_mq.h.

MqEnvCR

typedef struct MqEnvS MqEnvCR

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

Definition at line 827 of file LibMqMsgque_mq.h.

Function Documentation

MqEnv()

static MQ_ENV MqEnv ( MK_MNG mng )

inlinestatic

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

Definition at line 891 of file LibMqMsgque_mq.h.

                                     {
    return (MqEnvCheck(mng) ? (MQ_ENV)mng : NULL);
  }

MqEnvCheck()

static bool MqEnvCheck ( MK_MNGN mng )

inlinestatic

check MqEnvS -> MkObjectS::signature …

Returns

TRUE on valid env and FALSE an invalid env

Definition at line 866 of file LibMqMsgque_mq.h.

                                          {
    return MkSanitizeCheck(MqEnvC,mng);
  }

Here is the caller graph for this function:

MqEnvCheckO()

static bool MqEnvCheckO ( MK_OBJN obj )

inlinestatic

check MqEnvS -> MkObjectS::signature …

Returns

TRUE on valid env and FALSE an invalid env

Definition at line 874 of file LibMqMsgque_mq.h.

                                           {
    return MkSanitizeCheckO(MqEnvC,obj);
  }

MqEnvN()

static MQ_ENVN MqEnvN ( MK_MNGN mng )

inlinestatic

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

Definition at line 899 of file LibMqMsgque_mq.h.

                                        {
    return (MqEnvCheck(mng) ? (MQ_ENVN)mng : NULL);
  }