MqContextC_ErrorApi_Error_C_API

MqContextC - move and copy an error from a context … More...

Collaboration diagram for MqContextC_ErrorApi_Error_C_API:

Functions
enum MkErrorE	MqContextErrorCopy_RT (MK_RT mkrt, MQ_CTXN const targetCtx, MQ_CTXN const sourceCtx)
	copy a MkErrorS from the sourceCtx to the targetCtx …
enum MkErrorE	MqContextErrorMove_RT (MK_RT mkrt, MQ_CTXN const targetCtx, MQ_CTXN const sourceCtx)
	move a MkErrorS from the sourceCtx to the targetCtx …

MqContextC - MqContextC_ErrorApi_Error_C_API - function
MK_ERR	MqContextErrorFORMATP (MQ_CTXN const fmtobj)
	Non-inline replacement for MqContextErrorFORMAT …

MqContextC - MqContextC_ErrorApi_Error_C_API - overload
#define	MqContextErrorFORMAT_0()
#define	MqContextErrorCopy_NULL(...)
#define	MqContextErrorCopy(...)
#define	MqContextErrorCopy_E(...)
#define	MqContextErrorCopy_C(...)
#define	MqContextErrorMove_NULL(...)
#define	MqContextErrorMove(...)
#define	MqContextErrorMove_E(...)
#define	MqContextErrorMove_C(...)

Detailed Description

MqContextC - move and copy an error from a context …

Macro Definition Documentation

MqContextErrorCopy

#define MqContextErrorCopy

(

...

)

Value:

MqContextErrorCopy_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 185 of file msgque_overload_mq.h.

MqContextErrorCopy_C

#define MqContextErrorCopy_C

(

...

)

Value:

if (MkErrorCheckI(MqContextErrorCopy(__VA_ARGS__)))

Definition at line 187 of file msgque_overload_mq.h.

MqContextErrorCopy_E

#define MqContextErrorCopy_E

(

...

)

Value:

MkErrorCheck(MqContextErrorCopy(__VA_ARGS__))

Definition at line 186 of file msgque_overload_mq.h.

MqContextErrorCopy_NULL

#define MqContextErrorCopy_NULL

(

...

)

Value:

MqContextErrorCopy_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 184 of file msgque_overload_mq.h.

MqContextErrorFORMAT_0

#define MqContextErrorFORMAT_0

(

)

Value:

MqContextErrorFORMAT(NULL)

Definition at line 181 of file msgque_overload_mq.h.

MqContextErrorMove

#define MqContextErrorMove

(

...

)

Value:

MqContextErrorMove_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 189 of file msgque_overload_mq.h.

MqContextErrorMove_C

#define MqContextErrorMove_C

(

...

)

Value:

if (MkErrorCheckI(MqContextErrorMove(__VA_ARGS__)))

Definition at line 191 of file msgque_overload_mq.h.

MqContextErrorMove_E

#define MqContextErrorMove_E

(

...

)

Value:

MkErrorCheck(MqContextErrorMove(__VA_ARGS__))

Definition at line 190 of file msgque_overload_mq.h.

MqContextErrorMove_NULL

#define MqContextErrorMove_NULL

(

...

)

Value:

MqContextErrorMove_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 188 of file msgque_overload_mq.h.

Function Documentation

MqContextErrorCopy_RT()

enum MkErrorE MqContextErrorCopy_RT	(	MK_RT	mkrt,
		MQ_CTXN const	targetCtx,
		MQ_CTXN const	sourceCtx )

copy a MkErrorS from the sourceCtx to the targetCtx …

In rbmqmsgque the a MkRuntimeC is only one error-object per thread but this error-object has also addiitional attributes to identify the source of the error. In addition the rbmqmsgque has also an extended-error-object MqErrorS which also has error-specific-attributes. The MqContextErrorCopy is used to copy an error frome sourceCtx to targetCtx and keep the additional attributes in sync.

Note

• by default… every error set in a slave is also set in the master.
• by default… the error is only copied if sourceCtx and targetCtx are different.
• by default… the error is not copied if targetCtx MqConfigS::master of sourceCtx.
• by default… the copy only happen if sourceCtx has an error.
• on copy… the error of sourceCtx will be reset.

See also

MqContextErrorMove

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
	targetCtx	the MqContextC object and the target of the error
	sourceCtx	the MqContextC object and the source of the error

MqContextErrorFORMATP()

MK_ERR MqContextErrorFORMATP

(

MQ_CTXN const

fmtobj

)

Non-inline replacement for MqContextErrorFORMAT …

MqContextErrorMove_RT()

enum MkErrorE MqContextErrorMove_RT	(	MK_RT	mkrt,
		MQ_CTXN const	targetCtx,
		MQ_CTXN const	sourceCtx )

move a MkErrorS from the sourceCtx to the targetCtx …

Note

• by default… every error set in a slave is also set in the master.
• by default… the error is only copied if sourceCtx and targetCtx are different.
• by default… the error is not copied if targetCtx MqConfigS::master of sourceCtx.
• by default… the copy only happen if sourceCtx has an error.
• on copy… the error of sourceCtx will be reset.

See also

MqContextErrorCopy

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
	targetCtx	the MqContextC object and the target of the error
	sourceCtx	the MqContextC object and the source of the error and cleared