MqContextC - setup and manage a storage used to persist data-packages … More...

Collaboration diagram for MqContextC_StorageApi_CC_API:

Functions
MQ_LTR	ccmqmsgque::MqContextC::StorageDelete (MQ_LTR *transLIdP_inout=0)
	`C++: MQ_LTR ctx.StorageDelete(MQ_LTR transLIdP_inout = 0)` → C-API delete the storage-row* identified by the *transLIdP_inout* …

MQ_LTR	ccmqmsgque::MqContextC::StorageImport (MQ_LTR *transLIdP_inout=0)
	`C++: MQ_LTR ctx.StorageImport(MQ_LTR transLIdP_inout = 0)` → C-API import* the storage-package into the read-data-package …

void	ccmqmsgque::MqContextC::StorageClose ()
	`C++: ctx.StorageClose()` → C-API close the storage. …

void	ccmqmsgque::MqContextC::StorageDecrRef (MQ_LTR transLId)
	`C++: ctx.StorageDecrRef(MQ_LTR transLId)` → C-API decrease the internal refCount lock of the database-entry

void	ccmqmsgque::MqContextC::StorageIncrRef (MQ_LTR transLId)
	`C++: ctx.StorageIncrRef(MQ_LTR transLId)` → C-API increase the internal refCount lock of the database-entry

void	ccmqmsgque::MqContextC::StorageLog (MK_STRN callfunc=__builtin_FUNCTION())
	`C++: ctx.StorageLog(MK_STRN callfunc = __builtin_FUNCTION())` → C-API log the storage the status of the open transactions

void	ccmqmsgque::MqContextC::StorageOpen (MK_STRN storageFile)
	`C++: ctx.StorageOpen(MK_STRN storageFile)` → C-API switch to a file-based-transaction-database …

void	ccmqmsgque::MqContextC::StorageOpen (const std::string &storageFile)
	`C++: ctx.StorageOpen(MK_STRN storageFile)` → C-API switch to a file-based-transaction-database …

MQ_LTR	ccmqmsgque::MqContextC::StorageCount ()
	`C++: MQ_LTR ctx.StorageCount()` → C-API count the number of storage-rows …

MK_I32	ccmqmsgque::MqContextC::StorageErrCnt (MQ_LTR transLId)
	`C++: MK_I32 ctx.StorageErrCnt(MQ_LTR transLId)` → C-API increment and return the database row-error-count for the row defined with transLId

MQ_LTR	ccmqmsgque::MqContextC::StorageExport ()
	`C++: MQ_LTR ctx.StorageExport()` → C-API export the read-data-package into the STORAGE …

std::tuple< MqContextC *, MQ_LTR >	ccmqmsgque::MqContextC::StorageResolve ()
	`C++: {otherCtxP:MqContextC* otherLIdP:MQ_LTR} ctx.StorageResolve()` → C-API extract the `context->link.protect.rmtTransLId` entry from the database

Detailed Description

MqContextC - setup and manage a storage used to persist data-packages …

The storage is divided into: INTERNAL and EXTERNAL storage. Only the read-data-package can be stored or dumped into the storage.

The read-data-package is saved into the storage using:

ServiceStorage	setup a service listen on a MqContextC_ServiceApi_Identifer and save all read-data-package into the STORAGE …
StorageExport	export the read-data-package into the STORAGE …

The read-data-package is restored from the storage using:

StorageImport	import the storage-package into the read-data-package …
ProxyForward	send the entire read-data-package-data to the link-target …
All this usually happen in an Event Handler

Some important facts of the storage-feature:

The internal-storage depends on SQLite.
The package-storage can be used to save all kind of package-data.
The longterm-transaction-package-data is allways saved into storage.
By default only an in-memory storage is in use, but this can be changed with MqStorageOpen or Storage
An entire service-call can be saved with MqServiceStorage

The following internal storages are supported:

default: The default-storage is set with the configuration parameter --storage fileName and defaults to "#memdb#". If a package have to be saved into the storage and the storage is not open the default-storage id used. The open will always be performed. If an explicit storage is required the default can be changed or a storage can explicit be opened with MqStorageOpen. Keep in mind that the default-storage is a per-context configuration but only one storage per process or thread is currently supported.

memdb: This is the default storage and can be set explicitly with MqStorageOpen using the "#memdb#" parameter.

tmpdb: This storage is like an in-memory-storage but export data to the TEMPORARY filesystem if the application run out of memory. This storage can explicit be set with MqStorageOpen with the parameter "#tmpdb#".

filedb: This storage always work on files. Only this storage is persistent and can explicit be set with MqStorageOpen with the storageFile parameter.

Performance analyse:

The performance is tested with: Nhi1Exec perfclient.c --all --storage VALUE @ perfserver.c.
The parameter VALUE is set to #memdb#, #tmpdb# or a filedb file.
If –storage is not set the filedb database is used together with an internal file-name.

database	performance	host crash	application crash	info
memdb	30.000	data lost	data lost	non persistent
tempdb	< 30.000	data lost	data lost	uses memory and/or temporary file
filedb (mem)	10.000	data lost	data safe	in memory filesystem
filedb (disc)	50	data safe	data safe	disc-speed is the key factor

The storage is divided into: INTERNAL and EXTERNAL storage. Only the read-data-package can be stored or dumped into the storage.

The read-data-package is saved into the storage using:

ServiceStorage	setup a service listen on a MqContextC_ServiceApi_Identifer and save all read-data-package into the STORAGE …
StorageExport	export the read-data-package into the STORAGE …

The read-data-package is restored from the storage using:

StorageImport	import the storage-package into the read-data-package …
ProxyForward	send the entire read-data-package-data to the link-target …
All this usually happen in an Event Handler

Some important facts of the storage-feature:

The internal-storage depends on SQLite.
The package-storage can be used to save all kind of package-data.
The longterm-transaction-package-data is allways saved into storage.
By default only an in-memory storage is in use, but this can be changed with MqStorageOpen or Storage
An entire service-call can be saved with MqServiceStorage

The following internal storages are supported:

default: The default-storage is set with the configuration parameter --storage fileName and defaults to "#memdb#". If a package have to be saved into the storage and the storage is not open the default-storage id used. The open will always be performed. If an explicit storage is required the default can be changed or a storage can explicit be opened with MqStorageOpen. Keep in mind that the default-storage is a per-context configuration but only one storage per process or thread is currently supported.

memdb: This is the default storage and can be set explicitly with MqStorageOpen using the "#memdb#" parameter.

tmpdb: This storage is like an in-memory-storage but export data to the TEMPORARY filesystem if the application run out of memory. This storage can explicit be set with MqStorageOpen with the parameter "#tmpdb#".

filedb: This storage always work on files. Only this storage is persistent and can explicit be set with MqStorageOpen with the storageFile parameter.

Performance analyse:

The performance is tested with: Nhi1Exec perfclient.c --all --storage VALUE @ perfserver.c.
The parameter VALUE is set to #memdb#, #tmpdb# or a filedb file.
If –storage is not set the filedb database is used together with an internal file-name.

database	performance	host crash	application crash	info
memdb	30.000	data lost	data lost	non persistent
tempdb	< 30.000	data lost	data lost	uses memory and/or temporary file
filedb (mem)	10.000	data lost	data safe	in memory filesystem
filedb (disc)	50	data safe	data safe	disc-speed is the key factor

Function Documentation

◆ StorageClose()

void ccmqmsgque::MqContextC::StorageClose ( )

inline

C++: ctx.StorageClose() → C-API
close the storage. …

Definition at line 2244 of file MqContextC_inline_cc.hh.

                                         {
    MK_UNUSED auto ctx = getCTX();
    enum MkErrorE errVal = MqStorageClose(ctx);
    MkErrorC_Check(ctx, errVal);
  }

◆ StorageCount()

MQ_LTR ccmqmsgque::MqContextC::StorageCount ( )

inline

C++: MQ_LTR ctx.StorageCount() → C-API
count the number of storage-rows …

Definition at line 2290 of file MqContextC_inline_cc.hh.

                                           {
    MK_UNUSED auto ctx = getCTX();
    MQ_LTR cnt_out;
    enum MkErrorE errVal = MqStorageCount(ctx, &cnt_out);
    MkErrorC_Check(ctx, errVal);
    return cnt_out;
  }

Here is the caller graph for this function:

◆ StorageDecrRef()

void ccmqmsgque::MqContextC::StorageDecrRef ( MQ_LTR transLId )

inline

C++: ctx.StorageDecrRef(MQ_LTR transLId) → C-API
decrease the internal refCount lock of the database-entry

Definition at line 2251 of file MqContextC_inline_cc.hh.

                                                          {
    MK_UNUSED auto ctx = getCTX();
    enum MkErrorE errVal = MqStorageDecrRef(ctx, transLId);
    MkErrorC_Check(ctx, errVal);
  }

Here is the caller graph for this function:

◆ StorageDelete()

MQ_LTR ccmqmsgque::MqContextC::StorageDelete ( MQ_LTR * transLIdP_inout = 0 )

inline

C++: MQ_LTR ctx.StorageDelete(MQ_LTR *transLIdP_inout = 0) → C-API
delete the storage-row identified by the transLIdP_inout …

Definition at line 2222 of file MqContextC_inline_cc.hh.

                                                                   {
    MK_UNUSED auto ctx = getCTX();
    MQ_LTR transLIdP_inout_val = transLIdP_inout == NULL ? 0 : (MQ_LTR)(*transLIdP_inout);
    enum MkErrorE errVal = MqStorageDelete(ctx, &transLIdP_inout_val);
    if (transLIdP_inout != NULL) {*transLIdP_inout = (MQ_LTR)(transLIdP_inout_val);}
    MkErrorC_Check(ctx, errVal);
    return transLIdP_inout_val;
  }

Here is the caller graph for this function:

◆ StorageErrCnt()

MK_I32 ccmqmsgque::MqContextC::StorageErrCnt ( MQ_LTR transLId )

inline

C++: MK_I32 ctx.StorageErrCnt(MQ_LTR transLId) → C-API
increment and return the database row-error-count for the row defined with transLId

Definition at line 2299 of file MqContextC_inline_cc.hh.

                                                           {
    MK_UNUSED auto ctx = getCTX();
    MK_I32 cnt_out;
    enum MkErrorE errVal = MqStorageErrCnt(ctx, transLId, &cnt_out);
    MkErrorC_Check(ctx, errVal);
    return cnt_out;
  }

Here is the caller graph for this function:

◆ StorageExport()

MQ_LTR ccmqmsgque::MqContextC::StorageExport ( )

inline

C++: MQ_LTR ctx.StorageExport() → C-API
export the read-data-package into the STORAGE …

Definition at line 2308 of file MqContextC_inline_cc.hh.

                                            {
    MK_UNUSED auto ctx = getCTX();
    MQ_LTR ltid_out;
    enum MkErrorE errVal = MqStorageExport(ctx, &ltid_out);
    MkErrorC_Check(ctx, errVal);
    return ltid_out;
  }

Here is the caller graph for this function:

◆ StorageImport()

MQ_LTR ccmqmsgque::MqContextC::StorageImport ( MQ_LTR * transLIdP_inout = 0 )

inline

C++: MQ_LTR ctx.StorageImport(MQ_LTR *transLIdP_inout = 0) → C-API
import the storage-package into the read-data-package …

Definition at line 2232 of file MqContextC_inline_cc.hh.

                                                                   {
    MK_UNUSED auto ctx = getCTX();
    MQ_LTR transLIdP_inout_val = transLIdP_inout == NULL ? 0 : (MQ_LTR)(*transLIdP_inout);
    enum MkErrorE errVal = MqStorageImport(ctx, &transLIdP_inout_val);
    if (transLIdP_inout != NULL) {*transLIdP_inout = (MQ_LTR)(transLIdP_inout_val);}
    MkErrorC_Check(ctx, errVal);
    return transLIdP_inout_val;
  }

Here is the caller graph for this function:

◆ StorageIncrRef()

void ccmqmsgque::MqContextC::StorageIncrRef ( MQ_LTR transLId )

inline

C++: ctx.StorageIncrRef(MQ_LTR transLId) → C-API
increase the internal refCount lock of the database-entry

Definition at line 2258 of file MqContextC_inline_cc.hh.

                                                          {
    MK_UNUSED auto ctx = getCTX();
    enum MkErrorE errVal = MqStorageIncrRef(ctx, transLId);
    MkErrorC_Check(ctx, errVal);
  }

◆ StorageLog()

void ccmqmsgque::MqContextC::StorageLog ( MK_STRN callfunc = __builtin_FUNCTION() )

inline

C++: ctx.StorageLog(MK_STRN callfunc = __builtin_FUNCTION()) → C-API
log the storage the status of the open transactions

Definition at line 2265 of file MqContextC_inline_cc.hh.

                                                       {
    MK_UNUSED auto ctx = getCTX();
    if (callfunc == NULL) {callfunc = __builtin_FUNCTION();}
    enum MkErrorE errVal = MqStorageLog(ctx, callfunc);
    MkErrorC_Check(ctx, errVal);
  }

◆ StorageOpen() [1/2]

void ccmqmsgque::MqContextC::StorageOpen ( const std::string & storageFile )

inline

C++: ctx.StorageOpen(MK_STRN storageFile) → C-API
switch to a file-based-transaction-database …

Definition at line 2280 of file MqContextC_inline_cc.hh.

                                                                    {
    MK_UNUSED auto ctx = getCTX();
    const MK_STRN storageFile_hdl = storageFile.c_str();
    enum MkErrorE errVal = MqStorageOpen(ctx, storageFile_hdl);
    MkErrorC_Check(ctx, errVal);
  }

◆ StorageOpen() [2/2]

void ccmqmsgque::MqContextC::StorageOpen ( MK_STRN storageFile )

inline

C++: ctx.StorageOpen(MK_STRN storageFile) → C-API
switch to a file-based-transaction-database …

Definition at line 2273 of file MqContextC_inline_cc.hh.

                                                           {
    MK_UNUSED auto ctx = getCTX();
    enum MkErrorE errVal = MqStorageOpen(ctx, storageFile);
    MkErrorC_Check(ctx, errVal);
  }

◆ StorageResolve()

std::tuple< MqContextC *, MQ_LTR > ccmqmsgque::MqContextC::StorageResolve ( )

inline

C++: {otherCtxP:MqContextC* otherLIdP:MQ_LTR} ctx.StorageResolve() → C-API
extract the context->link.protect.rmtTransLId entry from the database

Definition at line 2317 of file MqContextC_inline_cc.hh.

                                                                   {
    MK_UNUSED auto ctx = getCTX();
    MQ_CTX otherCtxP_out;
    MQ_LTR otherLIdP_out;
    enum MkErrorE errVal = MqStorageResolve(ctx, &otherCtxP_out, &otherLIdP_out);
    MkErrorC_Check(ctx, errVal);
    std::tuple<MqContextC*,MQ_LTR> __retVal__L = {MqContextC::MqContextC_ObjNew(MK_RT_CALL otherCtxP_out),otherLIdP_out};
    return __retVal__L;
  }

Functions

Detailed Description

Function Documentation

◆ StorageClose()

◆ StorageCount()

◆ StorageDecrRef()

◆ StorageDelete()

◆ StorageErrCnt()

◆ StorageExport()

◆ StorageImport()

◆ StorageIncrRef()

◆ StorageLog()

◆ StorageOpen() [1/2]

◆ StorageOpen() [2/2]

◆ StorageResolve()