MqDumpC_CC_API

MqDumpC - the class known as dmp or dump is used to export a ccmqmsgque data package as binary … More...

Collaboration diagram for MqDumpC_CC_API:

Topics
	MqDumpC_Class_CC_API
	MqDumpC - define the class …
	MqDumpC_TOR_CC_API
	MqDumpC - various functions to create, initialize and destroy a dump …
	MqDumpC_Misc_CC_API
	MqDumpC - various functions to work on a dump …

Classes
struct	ccmqmsgque::MqDumpC_A
	MqDumpC - the class known as dmp or dump is used to export a ccmqmsgque data package as binary … → C-API: libmqmsgque::MqDumpS More...
class	ccmqmsgque::MqDumpC
	MqDumpC - the class known as dmp or dump is used to export a ccmqmsgque data package as binary … → C-API: libmqmsgque::MqDumpS More...

Functions
static MqDumpC *	ccmqmsgque::MqDumpC::MqDumpC_GetSelf (MQ_DMP hdl)
static MK_PTR	ccmqmsgque::MqDumpC::MqDumpC_selfCreate (MK_RT_ARGS MK_OBJ obj, MK_PTR const env)
static void	ccmqmsgque::MqDumpC::MqDumpC_selfDelete (MK_RT_ARGS MK_PTR self, MK_PTR env)
static void	ccmqmsgque::MqDumpC::MqDumpC_selfUnlink (MK_RT_ARGS MK_PTR self, MK_PTR env)
void	ccmqmsgque::MqDumpC::MqDumpC_Init (MQ_DMP hdl)
static MqDumpC *	ccmqmsgque::MqDumpC::MqDumpC_ObjCreate (MK_RT_ARGS MQ_DMP hdl)
	ccmqmsgque::MqDumpC::MqDumpC (MK_OBJ obj)
	ccmqmsgque::MqDumpC::MqDumpC (MQ_DMP hdl)
static MqDumpC *	ccmqmsgque::MqDumpC::MqDumpC_ObjNew (MK_RT_ARGS MQ_DMP hdl)
	return MqDumpC from LibMsgqueObject
MQ_DMP	ccmqmsgque::MqDumpC::getDMP () const
	return the LibMsgqueObject from current MqDumpC instance
MQ_DMP	ccmqmsgque::MqDumpC::getDMP__null_allow () const
	return the LibMsgqueObject from current MqDumpC instance
MQ_DMPN	ccmqmsgque::MqDumpC::getDMPN () const
	(const) return the LibMsgqueObject from current MqDumpC instance
MQ_DMPN	ccmqmsgque::MqDumpC::getDMPN__null_allow () const
	(const) return the LibMsgqueObject from current MqDumpC instance
static MQ_DMP	ccmqmsgque::MqDumpC::getDMP (MqDumpC *clsHdl)
	return LibMsgqueObject from current MqDumpC pointer
static MQ_DMP	ccmqmsgque::MqDumpC::getDMP__null_allow (MqDumpC *clsHdl)
	return LibMsgqueObject from current MqDumpC pointer
static MQ_DMPN	ccmqmsgque::MqDumpC::getDMPN (const MqDumpC *clsHdl)
	(const) return LibMsgqueObject from current MqDumpC pointer
static MQ_DMPN	ccmqmsgque::MqDumpC::getDMPN__null_allow (const MqDumpC *clsHdl)
	(const) return LibMsgqueObject from current MqDumpC pointer
static MQ_DMP	ccmqmsgque::MqDumpC::getDMP (const MqDumpC &clsHdl)
	return LibMsgqueObject from current MqDumpC reference
static MQ_DMP	ccmqmsgque::MqDumpC::getDMP__null_allow (const MqDumpC &clsHdl)
	return LibMsgqueObject from current MqDumpC reference
static MQ_DMPN	ccmqmsgque::MqDumpC::getDMPN (const MqDumpC &clsHdl)
	(const) return LibMsgqueObject from current MqDumpC reference
static MQ_DMPN	ccmqmsgque::MqDumpC::getDMPN__null_allow (const MqDumpC &clsHdl)
	(const) return LibMsgqueObject from current MqDumpC reference
bool	ccmqmsgque::MqDumpC::Check () const
	check if pointer is still valid
	ccmqmsgque::MqDumpC::MqDumpC ()

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

Detailed Description

MqDumpC - the class known as dmp or dump is used to export a ccmqmsgque data package as binary …

The dump is used to exchange data with external counterparts such as a database or a user-specific infrastructure.

There are 3 different function that deal with a dump:

1. The MqDumpExport export the read-data-package from the calling context to a dump.
2. The MqDumpImport imports the dump into the read-data-package of the calling context. All MqContextC READ API functions can be used to read the data from the read-data-package.
3. The MqProxyForward imports the dump into the send-data-package of the calling context. All MqContextC SEND API functions can be used to write the data into the send-data-package

See also

MqContextC PROXY API

Function Documentation

Check()

bool ccmqmsgque::MqDumpC::Check ( ) const

inline

check if pointer is still valid

Definition at line 150 of file MqDumpC_cc.hh.

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

getDMP() [1/3]

MQ_DMP ccmqmsgque::MqDumpC::getDMP ( ) const

inline

return the LibMsgqueObject from current MqDumpC instance

Definition at line 82 of file MqDumpC_cc.hh.

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

Here is the caller graph for this function:

getDMP() [2/3]

static MQ_DMP ccmqmsgque::MqDumpC::getDMP ( const MqDumpC & clsHdl )

inlinestatic

return LibMsgqueObject from current MqDumpC reference

Definition at line 130 of file MqDumpC_cc.hh.

                                                  {
        return clsHdl.getDMP();
      };

getDMP() [3/3]

static MQ_DMP ccmqmsgque::MqDumpC::getDMP ( MqDumpC * clsHdl )

inlinestatic

return LibMsgqueObject from current MqDumpC pointer

Definition at line 106 of file MqDumpC_cc.hh.

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

getDMP__null_allow() [1/3]

MQ_DMP ccmqmsgque::MqDumpC::getDMP__null_allow ( ) const

inline

return the LibMsgqueObject from current MqDumpC instance

Definition at line 89 of file MqDumpC_cc.hh.

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

Here is the caller graph for this function:

getDMP__null_allow() [2/3]

static MQ_DMP ccmqmsgque::MqDumpC::getDMP__null_allow ( const MqDumpC & clsHdl )

inlinestatic

return LibMsgqueObject from current MqDumpC reference

Definition at line 135 of file MqDumpC_cc.hh.

                                                              {
        return clsHdl.getDMP__null_allow();
      };

getDMP__null_allow() [3/3]

static MQ_DMP ccmqmsgque::MqDumpC::getDMP__null_allow ( MqDumpC * clsHdl )

inlinestatic

return LibMsgqueObject from current MqDumpC pointer

Definition at line 113 of file MqDumpC_cc.hh.

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

getDMPN() [1/3]

MQ_DMPN ccmqmsgque::MqDumpC::getDMPN ( ) const

inline

(const) return the LibMsgqueObject from current MqDumpC instance

Definition at line 94 of file MqDumpC_cc.hh.

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

Here is the caller graph for this function:

getDMPN() [2/3]

static MQ_DMPN ccmqmsgque::MqDumpC::getDMPN ( const MqDumpC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current MqDumpC reference

Definition at line 140 of file MqDumpC_cc.hh.

                                                    {
        return clsHdl.getDMPN();
      };

getDMPN() [3/3]

static MQ_DMPN ccmqmsgque::MqDumpC::getDMPN ( const MqDumpC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current MqDumpC pointer

Definition at line 118 of file MqDumpC_cc.hh.

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

getDMPN__null_allow() [1/3]

MQ_DMPN ccmqmsgque::MqDumpC::getDMPN__null_allow ( ) const

inline

(const) return the LibMsgqueObject from current MqDumpC instance

Definition at line 101 of file MqDumpC_cc.hh.

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

Here is the caller graph for this function:

getDMPN__null_allow() [2/3]

static MQ_DMPN ccmqmsgque::MqDumpC::getDMPN__null_allow ( const MqDumpC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current MqDumpC reference

Definition at line 145 of file MqDumpC_cc.hh.

                                                                {
        return clsHdl.getDMPN__null_allow();
      };

getDMPN__null_allow() [3/3]

static MQ_DMPN ccmqmsgque::MqDumpC::getDMPN__null_allow ( const MqDumpC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current MqDumpC pointer

Definition at line 125 of file MqDumpC_cc.hh.

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

MqDumpC() [1/3]

ccmqmsgque::MqDumpC::MqDumpC ( )

inlineprivate

Definition at line 158 of file MqDumpC_cc.hh.

{};

Here is the caller graph for this function:

MqDumpC() [2/3]

ccmqmsgque::MqDumpC::MqDumpC ( MK_OBJ obj )

inlineprivate

Definition at line 67 of file MqDumpC_cc.hh.

: MkObjectC(obj) {};

MqDumpC() [3/3]

ccmqmsgque::MqDumpC::MqDumpC ( MQ_DMP hdl )

inline

Definition at line 73 of file MqDumpC_cc.hh.

: MkObjectC(MqDumpC_X2obj(hdl)) {};

MqDumpC_GetSelf()

static MqDumpC * ccmqmsgque::MqDumpC::MqDumpC_GetSelf ( MQ_DMP hdl )

inlinestaticprivate

Definition at line 38 of file MqDumpC_cc.hh.

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

MqDumpC_Init()

void ccmqmsgque::MqDumpC::MqDumpC_Init ( MQ_DMP hdl )

inlineprivate

Definition at line 59 of file MqDumpC_cc.hh.

{ atomInit(MqDumpC_X2obj(hdl)); };

MqDumpC_ObjCreate()

static MqDumpC * ccmqmsgque::MqDumpC::MqDumpC_ObjCreate ( MK_RT_ARGS MQ_DMP hdl )

inlinestaticprivate

Definition at line 62 of file MqDumpC_cc.hh.

                                                                {
        return static_cast<MqDumpC*>(MkObjectC::atomObjCreate(MK_RT_CALL MqDumpC_X2obj(hdl)));
      }

Here is the caller graph for this function:

MqDumpC_ObjNew()

static MqDumpC * ccmqmsgque::MqDumpC::MqDumpC_ObjNew ( MK_RT_ARGS MQ_DMP hdl )

inlinestatic

return MqDumpC from LibMsgqueObject

Definition at line 77 of file MqDumpC_cc.hh.

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

Here is the caller graph for this function:

MqDumpC_selfCreate()

static MK_PTR ccmqmsgque::MqDumpC::MqDumpC_selfCreate ( MK_RT_ARGS MK_OBJ obj, MK_PTR const env )

inlinestaticprivate

Definition at line 45 of file MqDumpC_cc.hh.

                                                                                 {
        return new MqDumpC(obj);
      }

Here is the caller graph for this function:

MqDumpC_selfDelete()

static void ccmqmsgque::MqDumpC::MqDumpC_selfDelete ( MK_RT_ARGS MK_PTR self, MK_PTR env )

inlinestaticprivate

Definition at line 50 of file MqDumpC_cc.hh.

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

Here is the caller graph for this function:

MqDumpC_selfUnlink()

static void ccmqmsgque::MqDumpC::MqDumpC_selfUnlink ( MK_RT_ARGS MK_PTR self, MK_PTR env )

inlinestaticprivate

Definition at line 54 of file MqDumpC_cc.hh.

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

Here is the caller graph for this function:

Variable Documentation

MK_NULL_REF

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

static

Definition at line 34 of file MqDumpC_cc.hh.