MqDumpC - various functions to create, initialize and destroy a dump … More...

Collaboration diagram for MqDumpC_TOR_C_API:

Functions
enum MkErrorE	libmqmsgque::MqDumpExport_RT (MK_RT mkrt, MQ_CTX const ctx, MQ_DMP *const dumpP_inout)
	create a MqDumpC as export of the ctx-read-data-package …

enum MkErrorE	libmqmsgque::MqDumpError_RT (MK_RT mkrt, MQ_CTX const error, MQ_DMP *const dumpP_inout)
	export the context->error into the dump-package …

enum MkErrorE	libmqmsgque::MqDumpImport_RT (MK_RT mkrt, MQ_DMP const dump, MQ_CTX const ctx)
	import the dump-package into the ctx-read-data-package …

enum MkErrorE	libmqmsgque::MqDumpBinSet_RT (MK_RT mkrt, MkBinaryR data, MQ_DMP *dmp_out)
	create an `MqDumpS` object from binary data

MkBinaryR	libmqmsgque::MqDumpBinGet (MQ_DMPN const dump)
	export the binary data from an `MqDumpS` object

MqDumpDelete
void	libmqmsgque::MqDumpDelete_RT (MK_RT mkrt, MQ_DMP dmp)
	Destructor - delete a MqDumpC instance …

MqDumpC - MqDumpC_TOR_C_API - overload
#define	MqDumpError_NULL(...)

#define	MqDumpError(...)

#define	MqDumpError_E(...)

#define	MqDumpError_C(...)

#define	MqDumpError_e(...)

#define	MqDumpExport_NULL(...)

#define	MqDumpExport(...)

#define	MqDumpExport_E(...)

#define	MqDumpExport_C(...)

#define	MqDumpExport_e(...)

#define	MqDumpBinSet_NULL(...)

#define	MqDumpBinSet(...)

#define	MqDumpBinSet_E(...)

#define	MqDumpBinSet_C(...)

#define	MqDumpBinSet_e(...)

#define	MqDumpDelete(x)

#define	MqDumpImport_NULL(...)

#define	MqDumpImport(...)

#define	MqDumpImport_E(...)

#define	MqDumpImport_C(...)

Detailed Description

MqDumpC - various functions to create, initialize and destroy a dump …

Macro Definition Documentation

◆ MqDumpBinSet

#define MqDumpBinSet ( ... )

Value:

MqDumpBinSet_RT(MK_RT_CALL __VA_ARGS__)

MK_RT_CALL

#define MK_RT_CALL

Definition at line 942 of file msgque_overload_mq.h.

◆ MqDumpBinSet_C

#define MqDumpBinSet_C ( ... )

Value:

if (MkErrorCheckI(MqDumpBinSet(__VA_ARGS__)))

MqDumpBinSet

#define MqDumpBinSet(...)

Definition msgque_overload_mq.h:942

Definition at line 944 of file msgque_overload_mq.h.

◆ MqDumpBinSet_E

#define MqDumpBinSet_E ( ... )

Value:

MkErrorCheck(MqDumpBinSet(__VA_ARGS__))

Definition at line 943 of file msgque_overload_mq.h.

◆ MqDumpBinSet_e

#define MqDumpBinSet_e ( ... )

Value:

MK_EMBEDDED(MQ_DMP,MqDumpBinSet,__VA_ARGS__)

Definition at line 945 of file msgque_overload_mq.h.

◆ MqDumpBinSet_NULL

#define MqDumpBinSet_NULL ( ... )

Value:

MqDumpBinSet_RT(MK_RT_CALL_NULL __VA_ARGS__)

MK_RT_CALL_NULL

#define MK_RT_CALL_NULL

Definition at line 941 of file msgque_overload_mq.h.

◆ MqDumpDelete

#define MqDumpDelete ( x )

Value:

MkObjectDeleteToNull(MqDumpDelete_RT,MK,x)

MkObjectDeleteToNull

#define MkObjectDeleteToNull(fct, NS, x)

Definition at line 948 of file msgque_overload_mq.h.

◆ MqDumpError

#define MqDumpError ( ... )

Value:

MqDumpError_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 930 of file msgque_overload_mq.h.

◆ MqDumpError_C

#define MqDumpError_C ( ... )

Value:

if (MkErrorCheckI(MqDumpError(__VA_ARGS__)))

MqDumpError

#define MqDumpError(...)

Definition msgque_overload_mq.h:930

Definition at line 932 of file msgque_overload_mq.h.

◆ MqDumpError_E

#define MqDumpError_E ( ... )

Value:

MkErrorCheck(MqDumpError(__VA_ARGS__))

Definition at line 931 of file msgque_overload_mq.h.

◆ MqDumpError_e

#define MqDumpError_e ( ... )

Value:

MK_EMBEDDED(MQ_DMP,MqDumpError,__VA_ARGS__)

Definition at line 933 of file msgque_overload_mq.h.

◆ MqDumpError_NULL

#define MqDumpError_NULL ( ... )

Value:

MqDumpError_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 929 of file msgque_overload_mq.h.

◆ MqDumpExport

#define MqDumpExport ( ... )

Value:

MqDumpExport_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 935 of file msgque_overload_mq.h.

◆ MqDumpExport_C

#define MqDumpExport_C ( ... )

Value:

if (MkErrorCheckI(MqDumpExport(__VA_ARGS__)))

MqDumpExport

#define MqDumpExport(...)

Definition msgque_overload_mq.h:935

Definition at line 937 of file msgque_overload_mq.h.

◆ MqDumpExport_E

#define MqDumpExport_E ( ... )

Value:

MkErrorCheck(MqDumpExport(__VA_ARGS__))

Definition at line 936 of file msgque_overload_mq.h.

◆ MqDumpExport_e

#define MqDumpExport_e ( ... )

Value:

MK_EMBEDDED(MQ_DMP,MqDumpExport,__VA_ARGS__)

Definition at line 938 of file msgque_overload_mq.h.

◆ MqDumpExport_NULL

#define MqDumpExport_NULL ( ... )

Value:

MqDumpExport_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 934 of file msgque_overload_mq.h.

◆ MqDumpImport

#define MqDumpImport ( ... )

Value:

MqDumpImport_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 952 of file msgque_overload_mq.h.

◆ MqDumpImport_C

#define MqDumpImport_C ( ... )

Value:

if (MkErrorCheckI(MqDumpImport(__VA_ARGS__)))

MqDumpImport

#define MqDumpImport(...)

Definition msgque_overload_mq.h:952

Definition at line 954 of file msgque_overload_mq.h.

◆ MqDumpImport_E

#define MqDumpImport_E ( ... )

Value:

MkErrorCheck(MqDumpImport(__VA_ARGS__))

Definition at line 953 of file msgque_overload_mq.h.

◆ MqDumpImport_NULL

#define MqDumpImport_NULL ( ... )

Value:

MqDumpImport_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 951 of file msgque_overload_mq.h.

Function Documentation

◆ MqDumpBinGet()

MkBinaryR libmqmsgque::MqDumpBinGet ( MQ_DMPN const dump )

export the binary data from an MqDumpS object

Parameters

[in] dump the source object

Returns: The required MkBinaryR

Attention: The data still belongs to the MqDumpS object… do NOT free.

MkBinaryR MqDumpBinGet (
  MQ_DMPN const   dump
) {
  MK_INSTANCE_HDL(dump);
  return (MkBinaryR) {dump->size, (MK_BIN)dump};
}

Here is the caller graph for this function:

◆ MqDumpBinSet_RT()

enum MkErrorE libmqmsgque::MqDumpBinSet_RT	(	MK_RT	mkrt,
		MkBinaryR	data,
		MQ_DMP *	dmp_out )

create an MqDumpS object from binary data

Check the MqDumpC_SIGNATURE and set the refCount to 0

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	data	the binary data
[out]	dmp_out	the new MqDumpC

Exceptions

MkExceptionC → The default-exception from the Programming-Language-Micro-Kernel (PLMK)

Attention: The MqDumpS object is an pointer object… this mean the original data is still required and must NOT be freed.

enum MkErrorE MqDumpBinSet_RT (
  MK_RT_ARGS
  MkBinaryR  bin,
  MQ_DMP  *dmp_out
) {
  MK_STATIC_RT;
  assert(bin.data != NULL);
  assert(dmp_out!=NULL);
 
  MQ_DMP dump = (MQ_DMP) bin.data;
  if (!__MkCheckX(MqDumpC,dump)) {
    return MkErrorDbV_2_M(MK_ERROR_PRINT,MK_ERROR_VALUE_INVALID, "signature", "MqDumpS");
  } else {
    MkOBJ_R(dump).refCount = 0;
  }
  *dmp_out = dump;
  return MK_OK;
}

◆ MqDumpDelete_RT()

void libmqmsgque::MqDumpDelete_RT	(	MK_RT	mkrt,
		MQ_DMP	dmp )

Destructor - delete a MqDumpC instance …

See also: MqDumpExport MqDumpError MkObjectDelete

◆ MqDumpError_RT()

enum MkErrorE libmqmsgque::MqDumpError_RT	(	MK_RT	mkrt,
		MQ_CTX const	error,
		MQ_DMP *const	dumpP_inout )

export the context->error into the dump-package …

The export include all data required to setup a read-data-package later again. After import with MqDumpImport the read-data-package and the environment will be set as it was on MqDumpExport The export can be saved into an external storage or be used in a network-tunnel (example: the agurad tool).

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	error	the error-context to be exported into the dump-package-data
[in,out]	dumpP_inout	the *reference object* or `MK_NULL` at error

The reference object have to be non MK_NULL.
If reference object is a refrence to a non MK_NULL object than the reference object is populated with the result.
If reference object is a refrence to a MK_NULL object than :
- The reference object is set to the TLS alocated object owned by the Programming-Language-Micro-Kernel (PLMK).
- (do not free) The memory of the reference object value belongs to the called ccmqmsgque function and therefore never becomes MK_NULL for a non-error result.
  For details on the reference object value, see: MkKernel_Storage_C_API.
The newly created reference-object is owned by the caller.

Exceptions

MkExceptionC → The default-exception from the Programming-Language-Micro-Kernel (PLMK)

Attention: 1. use remarks from MqDumpExport
2. MqDumpError using the send-data-package to create the dump-package.. to use the send-data-package afterwords a MqSendSTART is required

See also: MqStorageExport, MqDumpImport, MqDumpExport

◆ MqDumpExport_RT()

enum MkErrorE libmqmsgque::MqDumpExport_RT	(	MK_RT	mkrt,
		MQ_CTX const	ctx,
		MQ_DMP *const	dumpP_inout )

create a MqDumpC as export of the ctx-read-data-package …

The new instance belongs to the caller and may have to be released if necessary. A manual release using DumpDelete is always possible, but the instance can no longer be used afterwards.

The export include all data required to setup a read-data-package again later. After import with MqDumpImport the read-data-package and the environment will be set as it was on MqDumpExport The export can be saved into an external storage or be used in a network-tunnel (example: the aguard tool).

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	ctx	the context to be exported into the dump-package-data
[in,out]	dumpP_inout	the *reference object* or `MK_NULL` at error

The reference object have to be non MK_NULL.
If reference object is a refrence to a non MK_NULL object than the reference object is populated with the result.
If reference object is a refrence to a MK_NULL object than :
- The reference object is set to the TLS alocated object owned by the Programming-Language-Micro-Kernel (PLMK).
- (do not free) The memory of the reference object value belongs to the called ccmqmsgque function and therefore never becomes MK_NULL for a non-error result.
  For details on the reference object value, see: MkKernel_Storage_C_API.
The newly created reference-object is owned by the caller.

Exceptions

MkExceptionC → The default-exception from the Programming-Language-Micro-Kernel (PLMK)

See also: MqStorageExport, MqDumpImport, MqDumpError

Attention: 1. The goal of this function is to create a dump to be loaded in the context later. If the context is not the original context… propably additional work is necessary.
2. The MqDumpExport is using realloc to allocate space. The value of *value should be initialized with either MK_NULL or a result of a previous MqDumpExport or MqDumpError.
3. Garbage is detected using MqDumpC_SIGNATURE… there is a MINIMAL chance (1 to 4.294.967.295) that the gargabe is NOT detected… to be save… always initialize the dump.
4. If the dump was initialized with MK_NULL or garbage … new memory will be allocated… If the dump memory will NOT be reused… free the memory with (6.)
5. If the dump was initialized with an previous dump … the memory will be reused… and extended with realloc if required.
6. Free the memory with MqDumpDelete.
7. On error… the dump is unchanged.
8. In case of TLS memory returned read more at MkKernel_Storage_C_API.

◆ MqDumpImport_RT()

enum MkErrorE libmqmsgque::MqDumpImport_RT	(	MK_RT	mkrt,
		MQ_DMP const	dump,
		MQ_CTX const	ctx )

import the dump-package into the ctx-read-data-package …

The dump is the result of a previous MqDumpExport function call. After the load an package is suitable for all kind of MqContextC READ API function. To just forward the package use the MqProxyForward function.

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	dump	the dump-package to be imported
[in]	ctx	the context in wich the dump-package is imported

Exceptions

MkExceptionC → The default-exception from the Programming-Language-Micro-Kernel (PLMK)

Attention

- The memory is dynamic-allocated and can be reused for the next MqDumpExport.

(do not free) The memory of the out/return value belongs to the called ccmqmsgque function and therefore never becomes MK_NULL for a non-error result.
For details on the out/return value, see: MkKernel_Storage_C_API.

See also: MqStorageExport, MqDumpExport, MqDumpError

Functions

MqDumpDelete

MqDumpC - MqDumpC_TOR_C_API - overload

Detailed Description

Macro Definition Documentation

◆ MqDumpBinSet

◆ MqDumpBinSet_C

◆ MqDumpBinSet_E

◆ MqDumpBinSet_e

◆ MqDumpBinSet_NULL

◆ MqDumpDelete

◆ MqDumpError

◆ MqDumpError_C

◆ MqDumpError_E

◆ MqDumpError_e

◆ MqDumpError_NULL

◆ MqDumpExport

◆ MqDumpExport_C

◆ MqDumpExport_E

◆ MqDumpExport_e

◆ MqDumpExport_NULL

◆ MqDumpImport

◆ MqDumpImport_C

◆ MqDumpImport_E

◆ MqDumpImport_NULL

Function Documentation

◆ MqDumpBinGet()

◆ MqDumpBinSet_RT()

◆ MqDumpDelete_RT()

◆ MqDumpError_RT()

◆ MqDumpExport_RT()

◆ MqDumpImport_RT()