MqContextC_StorageApi_TCL_API

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

Collaboration diagram for MqContextC_StorageApi_TCL_API:

Functions
static OT_ProcRet	tclmqmsgque_MqContextC_StorageDelete (MqContextC_ARGS)
	Tcl: int32 [$ctx StorageDelete ?*transLIdP_inout:int32=0?] → C-API delete the storage-row identified by the transLIdP_inout …
static OT_ProcRet	tclmqmsgque_MqContextC_StorageImport (MqContextC_ARGS)
	Tcl: int32 [$ctx StorageImport ?*transLIdP_inout:int32=0?] → C-API import the storage-package into the read-data-package …
static OT_ProcRet	tclmqmsgque_MqContextC_StorageClose (MqContextC_ARGS)
	Tcl: $ctx StorageClose → C-API close the storage. …
static OT_ProcRet	tclmqmsgque_MqContextC_StorageDecrRef (MqContextC_ARGS)
	Tcl: $ctx StorageDecrRef transLId:int32 → C-API decrease the internal refCount lock of the database-entry
static OT_ProcRet	tclmqmsgque_MqContextC_StorageIncrRef (MqContextC_ARGS)
	Tcl: $ctx StorageIncrRef transLId:int32 → C-API increase the internal refCount lock of the database-entry
static OT_ProcRet	tclmqmsgque_MqContextC_StorageLog (MqContextC_ARGS)
	Tcl: $ctx StorageLog ?callfunc:string="MK_NULL"? → C-API log the storage the status of the open transactions
static OT_ProcRet	tclmqmsgque_MqContextC_StorageOpen (MqContextC_ARGS)
	Tcl: $ctx StorageOpen storageFile:string → C-API switch to a file-based-transaction-database …
static OT_ProcRet	tclmqmsgque_MqContextC_StorageCount (MqContextC_ARGS)
	Tcl: int32 [$ctx StorageCount] → C-API count the number of storage-rows …
static OT_ProcRet	tclmqmsgque_MqContextC_StorageErrCnt (MqContextC_ARGS)
	Tcl: int32 [$ctx StorageErrCnt transLId:int32] → C-API increment and return the database row-error-count for the row defined with transLId
static OT_ProcRet	tclmqmsgque_MqContextC_StorageExport (MqContextC_ARGS)
	Tcl: int32 [$ctx StorageExport] → C-API export the read-data-package into the STORAGE …
static OT_ProcRet	tclmqmsgque_MqContextC_StorageResolve (MqContextC_ARGS)
	Tcl: {otherCtxP:MqContextC otherLIdP:int32} [$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

Function Documentation

tclmqmsgque_MqContextC_StorageClose()

static OT_ProcRet tclmqmsgque_MqContextC_StorageClose ( MqContextC_ARGS )

static

Tcl: $ctx StorageClose → C-API
close the storage. …

Definition at line 3444 of file MqContextC_tcl.c.

                                                                {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(StorageClose_doc);
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqStorageClose (hdl));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmqmsgque_MqContextC_StorageCount()

static OT_ProcRet tclmqmsgque_MqContextC_StorageCount ( MqContextC_ARGS )

static

Tcl: int32 [$ctx StorageCount] → C-API
count the number of storage-rows …

Definition at line 3526 of file MqContextC_tcl.c.

                                                                {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(StorageCount_doc);
  OT_CHECK_NOARGS;
  MQ_LTR cnt_out;
  MkErrorC_Check(hdl,MqStorageCount (hdl, &cnt_out));
  OT_retObj_SET_I32(cnt_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmqmsgque_MqContextC_StorageDecrRef()

static OT_ProcRet tclmqmsgque_MqContextC_StorageDecrRef ( MqContextC_ARGS )

static

Tcl: $ctx StorageDecrRef transLId:int32 → C-API
decrease the internal refCount lock of the database-entry

Definition at line 3458 of file MqContextC_tcl.c.

                                                                  {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(StorageDecrRef_doc);
  MQ_LTR transLId = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (transLId))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqStorageDecrRef (hdl, transLId));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmqmsgque_MqContextC_StorageDelete()

static OT_ProcRet tclmqmsgque_MqContextC_StorageDelete ( MqContextC_ARGS )

static

Tcl: int32 [$ctx StorageDelete ?*transLIdP_inout:int32=0?] → C-API
delete the storage-row identified by the transLIdP_inout …

Definition at line 3410 of file MqContextC_tcl.c.

                                                                 {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,1,StorageDelete_doc);
  MQ_LTR transLIdP_inout = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (transLIdP_inout))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqStorageDelete (hdl, &transLIdP_inout));
  OT_retObj_SET_I32(transLIdP_inout);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmqmsgque_MqContextC_StorageErrCnt()

static OT_ProcRet tclmqmsgque_MqContextC_StorageErrCnt ( MqContextC_ARGS )

static

Tcl: int32 [$ctx StorageErrCnt transLId:int32] → C-API
increment and return the database row-error-count for the row defined with transLId

Definition at line 3541 of file MqContextC_tcl.c.

                                                                 {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(StorageErrCnt_doc);
  MQ_LTR transLId = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (transLId))
  OT_CHECK_NOARGS;
  MK_I32 cnt_out;
  MkErrorC_Check(hdl,MqStorageErrCnt (hdl, transLId, &cnt_out));
  OT_retObj_SET_I32(cnt_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmqmsgque_MqContextC_StorageExport()

static OT_ProcRet tclmqmsgque_MqContextC_StorageExport ( MqContextC_ARGS )

static

Tcl: int32 [$ctx StorageExport] → C-API
export the read-data-package into the STORAGE …

Definition at line 3558 of file MqContextC_tcl.c.

                                                                 {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(StorageExport_doc);
  OT_CHECK_NOARGS;
  MQ_LTR ltid_out;
  MkErrorC_Check(hdl,MqStorageExport (hdl, &ltid_out));
  OT_retObj_SET_I32(ltid_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmqmsgque_MqContextC_StorageImport()

static OT_ProcRet tclmqmsgque_MqContextC_StorageImport ( MqContextC_ARGS )

static

Tcl: int32 [$ctx StorageImport ?*transLIdP_inout:int32=0?] → C-API
import the storage-package into the read-data-package …

Definition at line 3426 of file MqContextC_tcl.c.

                                                                 {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,1,StorageImport_doc);
  MQ_LTR transLIdP_inout = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (transLIdP_inout))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqStorageImport (hdl, &transLIdP_inout));
  OT_retObj_SET_I32(transLIdP_inout);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmqmsgque_MqContextC_StorageIncrRef()

static OT_ProcRet tclmqmsgque_MqContextC_StorageIncrRef ( MqContextC_ARGS )

static

Tcl: $ctx StorageIncrRef transLId:int32 → C-API
increase the internal refCount lock of the database-entry

Definition at line 3474 of file MqContextC_tcl.c.

                                                                  {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(StorageIncrRef_doc);
  MQ_LTR transLId = 0;
  OT_CHECK_REQUIRED(OT_CHECK_NI4 (transLId))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqStorageIncrRef (hdl, transLId));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmqmsgque_MqContextC_StorageLog()

static OT_ProcRet tclmqmsgque_MqContextC_StorageLog ( MqContextC_ARGS )

static

Tcl: $ctx StorageLog ?callfunc:string="MK_NULL"? → C-API
log the storage the status of the open transactions

Definition at line 3490 of file MqContextC_tcl.c.

                                                              {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,1,StorageLog_doc);
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  OT_CHECK_NOARGS;
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MkErrorC_Check(hdl,MqStorageLog (hdl, callfunc));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

tclmqmsgque_MqContextC_StorageOpen()

static OT_ProcRet tclmqmsgque_MqContextC_StorageOpen ( MqContextC_ARGS )

static

Tcl: $ctx StorageOpen storageFile:string → C-API
switch to a file-based-transaction-database …

Definition at line 3508 of file MqContextC_tcl.c.

                                                               {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(StorageOpen_doc);
  MK_STRN storageFile = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (storageFile))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqStorageOpen (hdl, storageFile));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmqmsgque_MqContextC_StorageResolve()

static OT_ProcRet tclmqmsgque_MqContextC_StorageResolve ( MqContextC_ARGS )

static

Tcl: {otherCtxP:MqContextC otherLIdP:int32} [$ctx StorageResolve] → C-API
extract the context->link.protect.rmtTransLId entry from the database

Definition at line 3573 of file MqContextC_tcl.c.

                                                                  {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(StorageResolve_doc);
  OT_CHECK_NOARGS;
  MQ_CTX otherCtxP_out;
  MQ_LTR otherLIdP_out;
  MkErrorC_Check(hdl,MqStorageResolve (hdl, &otherCtxP_out, &otherLIdP_out));
  OT_retObj_SET_List;
  OT_retObj_APPEND(OT_TMP_CTX_OBJ(otherCtxP_out));
  OT_retObj_APPEND(OT_TMP_I32_OBJ(otherLIdP_out));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}