MqFactoryC_CC_API

MqFactoryC - the class known as fct or factory is used to provide an interface to create one or more new MqContextC … More...

Collaboration diagram for MqFactoryC_CC_API:

Topics
	MqFactoryC_Class_CC_API
	MqFactoryC - define the class …
	MqFactoryC_TOR_CC_API
	MqFactoryC - various functions to create, initialize and destroy a factory …
	MqFactoryC_Get_CC_API
	MqFactoryC - various functions to 'get' data out of a factory …
	MqFactoryC_Misc_CC_API
	MqFactoryC - various functions to work on a factory …

Classes
struct	ccmqmsgque::MqFactoryC_A
	data used to define a factory → C-API: libmqmsgque::MqFactoryS More...
class	ccmqmsgque::MqFactoryC
	data used to define a factory → C-API: libmqmsgque::MqFactoryS More...
class	ccmqmsgque::MqFactoryCT< T >
	template wrapper for libmqmsgque::MqFactoryS More...

Functions
static MqFactoryC *	ccmqmsgque::MqFactoryC::MqFactoryC_GetSelf (MQ_FCT hdl)
static MK_PTR	ccmqmsgque::MqFactoryC::MqFactoryC_selfCreate (MK_RT_ARGS MK_OBJ obj, MK_PTR const env)
static void	ccmqmsgque::MqFactoryC::MqFactoryC_selfDelete (MK_RT_ARGS MK_PTR self, MK_PTR env)
static void	ccmqmsgque::MqFactoryC::MqFactoryC_selfUnlink (MK_RT_ARGS MK_PTR self, MK_PTR env)
void	ccmqmsgque::MqFactoryC::MqFactoryC_Init (MQ_FCT hdl)
static MqFactoryC *	ccmqmsgque::MqFactoryC::MqFactoryC_ObjCreate (MK_RT_ARGS MQ_FCT hdl)
	ccmqmsgque::MqFactoryC::MqFactoryC (MK_OBJ obj)
	ccmqmsgque::MqFactoryC::MqFactoryC (MQ_FCT hdl)
static MqFactoryC *	ccmqmsgque::MqFactoryC::MqFactoryC_ObjNew (MK_RT_ARGS MQ_FCT hdl)
	return MqFactoryC from LibMsgqueObject
MQ_FCT	ccmqmsgque::MqFactoryC::getFCT () const
	return the LibMsgqueObject from current MqFactoryC instance
MQ_FCT	ccmqmsgque::MqFactoryC::getFCT__null_allow () const
	return the LibMsgqueObject from current MqFactoryC instance
MQ_FCTN	ccmqmsgque::MqFactoryC::getFCTN () const
	(const) return the LibMsgqueObject from current MqFactoryC instance
MQ_FCTN	ccmqmsgque::MqFactoryC::getFCTN__null_allow () const
	(const) return the LibMsgqueObject from current MqFactoryC instance
static MQ_FCT	ccmqmsgque::MqFactoryC::getFCT (MqFactoryC *clsHdl)
	return LibMsgqueObject from current MqFactoryC pointer
static MQ_FCT	ccmqmsgque::MqFactoryC::getFCT__null_allow (MqFactoryC *clsHdl)
	return LibMsgqueObject from current MqFactoryC pointer
static MQ_FCTN	ccmqmsgque::MqFactoryC::getFCTN (const MqFactoryC *clsHdl)
	(const) return LibMsgqueObject from current MqFactoryC pointer
static MQ_FCTN	ccmqmsgque::MqFactoryC::getFCTN__null_allow (const MqFactoryC *clsHdl)
	(const) return LibMsgqueObject from current MqFactoryC pointer
static MQ_FCT	ccmqmsgque::MqFactoryC::getFCT (const MqFactoryC &clsHdl)
	return LibMsgqueObject from current MqFactoryC reference
static MQ_FCT	ccmqmsgque::MqFactoryC::getFCT__null_allow (const MqFactoryC &clsHdl)
	return LibMsgqueObject from current MqFactoryC reference
static MQ_FCTN	ccmqmsgque::MqFactoryC::getFCTN (const MqFactoryC &clsHdl)
	(const) return LibMsgqueObject from current MqFactoryC reference
static MQ_FCTN	ccmqmsgque::MqFactoryC::getFCTN__null_allow (const MqFactoryC &clsHdl)
	(const) return LibMsgqueObject from current MqFactoryC reference
bool	ccmqmsgque::MqFactoryC::Check () const
	check if pointer is still valid
	ccmqmsgque::MqFactoryC::MqFactoryC ()

Variables
static thread_local MqFactoryC	ccmqmsgque::MqFactoryC::MK_NULL_REF = {(MK_OBJ)0}

Detailed Description

MqFactoryC - the class known as fct or factory is used to provide an interface to create one or more new MqContextC …

The factory is an important part of the object management and has the following basic features:

1. create/delete a MqContextC defined by a MqFactoryC
2. infrastructure to host multiple MqFactoryC in a single executable
3. provide an identifier used for factory-lookup and as an unique-application-name
4. identification of a client and a server in an application-link

Without a factory only the pipe-feature without the child-feature is guaranteed to work. Other features may work, this depends of the "flexibility" of the programming-language.

The link between the MqFactoryS-identifier and the MqFactoryC is important for the future development of ccmqmsgque. Message-Routing, Service-Location and Persistent-Transactions depend on this feature.

The relationship between the MqFactoryC and the MqContextC is the same as the relationship between a type (MqFactoryS) and an object (MqContextS) of a regular programming language. The MqFactoryC define the type of the server and the MqContextC define a single object of the server process or thread.

                                     Application
|-------------------------------------------------------------------------------------|
|--------------- physical host 1 -----------------------|------ physical host 2 ------|
|-------- process-1 --------|-------- process-2 --------|-- process-3 --|---- … ------|
 thread-1     thread-2…      thread-1…     thread-2…      thread-1…       thread-…
  factory-A     factory-X     factory-Y…    factory-Z…
   object-1     object-1   object-…    …
   object-2     object-2   …
   object-3     object-3
   …              …

A server has a single MqFactoryC object per thread or process but multiple MqFactoryC objects per application. Decreasing the size and the complexity of a MqContextC object will improve the server performance. In future more fields, defined in the libmqmsgque::MqSetupS attribute of the the MqContextC object, will move into MqFactoryC object.

Function Documentation

Check()

bool ccmqmsgque::MqFactoryC::Check ( ) const

inline

check if pointer is still valid

Definition at line 151 of file MqFactoryC_cc.hh.

                         {
        return (hdl && MqFctCheck(hdl));
      };

getFCT() [1/3]

MQ_FCT ccmqmsgque::MqFactoryC::getFCT ( ) const

inline

return the LibMsgqueObject from current MqFactoryC instance

Definition at line 83 of file MqFactoryC_cc.hh.

                            {
        MQ_FCT ret = reinterpret_cast<MQ_FCT>(hdl);
        if (unlikely(ret == NULL)) InstHdlIsNullError();
        return ret;
      };

Here is the caller graph for this function:

getFCT() [2/3]

static MQ_FCT ccmqmsgque::MqFactoryC::getFCT ( const MqFactoryC & clsHdl )

inlinestatic

return LibMsgqueObject from current MqFactoryC reference

Definition at line 131 of file MqFactoryC_cc.hh.

                                                     {
        return clsHdl.getFCT();
      };

getFCT() [3/3]

static MQ_FCT ccmqmsgque::MqFactoryC::getFCT ( MqFactoryC * clsHdl )

inlinestatic

return LibMsgqueObject from current MqFactoryC pointer

Definition at line 107 of file MqFactoryC_cc.hh.

                                               {
        MQ_FCT ret = clsHdl ? reinterpret_cast<MQ_FCT>(clsHdl->hdl) : NULL;
        if (unlikely(ret == NULL)) ClassHdlIsNullError(MqFactoryC);
        return ret;
      };

getFCT__null_allow() [1/3]

MQ_FCT ccmqmsgque::MqFactoryC::getFCT__null_allow ( ) const

inline

return the LibMsgqueObject from current MqFactoryC instance

Definition at line 90 of file MqFactoryC_cc.hh.

                                        {
        return reinterpret_cast<MQ_FCT>(hdl);
      };

Here is the caller graph for this function:

getFCT__null_allow() [2/3]

static MQ_FCT ccmqmsgque::MqFactoryC::getFCT__null_allow ( const MqFactoryC & clsHdl )

inlinestatic

return LibMsgqueObject from current MqFactoryC reference

Definition at line 136 of file MqFactoryC_cc.hh.

                                                                 {
        return clsHdl.getFCT__null_allow();
      };

getFCT__null_allow() [3/3]

static MQ_FCT ccmqmsgque::MqFactoryC::getFCT__null_allow ( MqFactoryC * clsHdl )

inlinestatic

return LibMsgqueObject from current MqFactoryC pointer

Definition at line 114 of file MqFactoryC_cc.hh.

                                                           {
        return clsHdl ? reinterpret_cast<MQ_FCT>(clsHdl->hdl) : NULL;
      };

getFCTN() [1/3]

MQ_FCTN ccmqmsgque::MqFactoryC::getFCTN ( ) const

inline

(const) return the LibMsgqueObject from current MqFactoryC instance

Definition at line 95 of file MqFactoryC_cc.hh.

                              {
        MQ_FCTN ret = reinterpret_cast<MQ_FCTN>(hdl);
        if (unlikely(ret == NULL)) InstHdlIsNullError();
        return ret;
      };

Here is the caller graph for this function:

getFCTN() [2/3]

static MQ_FCTN ccmqmsgque::MqFactoryC::getFCTN ( const MqFactoryC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current MqFactoryC reference

Definition at line 141 of file MqFactoryC_cc.hh.

                                                       {
        return clsHdl.getFCTN();
      };

getFCTN() [3/3]

static MQ_FCTN ccmqmsgque::MqFactoryC::getFCTN ( const MqFactoryC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current MqFactoryC pointer

Definition at line 119 of file MqFactoryC_cc.hh.

                                                       {
        MQ_FCTN ret = clsHdl ? reinterpret_cast<MQ_FCTN>(clsHdl->hdl) : NULL;
        if (unlikely(ret == NULL)) ClassHdlIsNullError(MqFactoryC);
        return ret;
      };

getFCTN__null_allow() [1/3]

MQ_FCTN ccmqmsgque::MqFactoryC::getFCTN__null_allow ( ) const

inline

(const) return the LibMsgqueObject from current MqFactoryC instance

Definition at line 102 of file MqFactoryC_cc.hh.

                                          {
        return reinterpret_cast<MQ_FCTN>(hdl);
      };

Here is the caller graph for this function:

getFCTN__null_allow() [2/3]

static MQ_FCTN ccmqmsgque::MqFactoryC::getFCTN__null_allow ( const MqFactoryC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current MqFactoryC reference

Definition at line 146 of file MqFactoryC_cc.hh.

                                                                   {
        return clsHdl.getFCTN__null_allow();
      };

getFCTN__null_allow() [3/3]

static MQ_FCTN ccmqmsgque::MqFactoryC::getFCTN__null_allow ( const MqFactoryC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current MqFactoryC pointer

Definition at line 126 of file MqFactoryC_cc.hh.

                                                                   {
        return clsHdl ? reinterpret_cast<MQ_FCTN>(clsHdl->hdl) : NULL;
      };

MqFactoryC() [1/3]

ccmqmsgque::MqFactoryC::MqFactoryC ( )

inlineprivate

Definition at line 159 of file MqFactoryC_cc.hh.

{};

Here is the caller graph for this function:

MqFactoryC() [2/3]

ccmqmsgque::MqFactoryC::MqFactoryC ( MK_OBJ obj )

inlineprivate

Definition at line 68 of file MqFactoryC_cc.hh.

: MkObjectC(obj) {};

MqFactoryC() [3/3]

ccmqmsgque::MqFactoryC::MqFactoryC ( MQ_FCT hdl )

inline

Definition at line 74 of file MqFactoryC_cc.hh.

: MkObjectC(MqFactoryC_X2obj(hdl)) {};

MqFactoryC_GetSelf()

static MqFactoryC * ccmqmsgque::MqFactoryC::MqFactoryC_GetSelf ( MQ_FCT hdl )

inlinestaticprivate

Definition at line 39 of file MqFactoryC_cc.hh.

                                                         {
        return (hdl != NULL ? static_cast<MqFactoryC*>((*MqFactoryC_X2obj(hdl)).self) : &MK_NULL_REF);
      }

MqFactoryC_Init()

void ccmqmsgque::MqFactoryC::MqFactoryC_Init ( MQ_FCT hdl )

inlineprivate

Definition at line 60 of file MqFactoryC_cc.hh.

{ atomInit(MqFactoryC_X2obj(hdl)); };

MqFactoryC_ObjCreate()

static MqFactoryC * ccmqmsgque::MqFactoryC::MqFactoryC_ObjCreate ( MK_RT_ARGS MQ_FCT hdl )

inlinestaticprivate

Definition at line 63 of file MqFactoryC_cc.hh.

                                                                      {
        return static_cast<MqFactoryC*>(MkObjectC::atomObjCreate(MK_RT_CALL MqFactoryC_X2obj(hdl)));
      }

Here is the caller graph for this function:

MqFactoryC_ObjNew()

static MqFactoryC * ccmqmsgque::MqFactoryC::MqFactoryC_ObjNew ( MK_RT_ARGS MQ_FCT hdl )

inlinestatic

return MqFactoryC from LibMsgqueObject

Definition at line 78 of file MqFactoryC_cc.hh.

                                                                   {
        return (hdl ? static_cast<MqFactoryC*>(MkObjectC::atomObjNew(MK_RT_CALL MqFactoryC_X2obj(hdl))) : &MK_NULL_REF);
      }

Here is the caller graph for this function:

MqFactoryC_selfCreate()

static MK_PTR ccmqmsgque::MqFactoryC::MqFactoryC_selfCreate ( MK_RT_ARGS MK_OBJ obj, MK_PTR const env )

inlinestaticprivate

Definition at line 46 of file MqFactoryC_cc.hh.

                                                                                    {
        return new MqFactoryC(obj);
      }

Here is the caller graph for this function:

MqFactoryC_selfDelete()

static void ccmqmsgque::MqFactoryC::MqFactoryC_selfDelete ( MK_RT_ARGS MK_PTR self, MK_PTR env )

inlinestaticprivate

Definition at line 51 of file MqFactoryC_cc.hh.

                                                                             {
        delete static_cast<MqFactoryC*>(self);
      }

Here is the caller graph for this function:

MqFactoryC_selfUnlink()

static void ccmqmsgque::MqFactoryC::MqFactoryC_selfUnlink ( MK_RT_ARGS MK_PTR self, MK_PTR env )

inlinestaticprivate

Definition at line 55 of file MqFactoryC_cc.hh.

                                                                             {
        MqFactoryC* selfO = static_cast<MqFactoryC*>(self);
        selfO->atomUnlink();
      }

Here is the caller graph for this function:

Variable Documentation

MK_NULL_REF

thread_local MqFactoryC ccmqmsgque::MqFactoryC::MK_NULL_REF = {(MK_OBJ)0}

static

Definition at line 35 of file MqFactoryC_cc.hh.