MqErrorC_C_API

MqErrorS - the class known as err or error is the extension of the kernel-error MkErrorS … More...

Collaboration diagram for MqErrorC_C_API:

Topics
	MqErrorC_Class_C_API
	MqErrorS - define the class …
	MqErrorC_Class_Define_C_API
	MqErrorS - low level definition, access and cast …

Data Structures
struct	MqErrorS
	Extend the MkErrorS with libmqmsgque specific features … More...

Functions
void	MqErrorEnvReset (MQ_ERR const err)
	reset the MqErrorS::client_protect and the MqErrorS::server_protect …

access the predefined error from \ref doc_mk_c_MkRuntimeC
#define	MqERROR_R(r)
#define	MqERROR_RT   MqERROR_R(&MQ_RT_REF)
#define	MqERROR_O(o)
#define	MqERROR_X(x)
#define	MqERROR_XN(x)
#define	MqERROR   MqERROR_R(&MqRuntimeRLS)

Detailed Description

MqErrorS - the class known as err or error is the extension of the kernel-error MkErrorS …

An error is a singleton, one error per runtime. After splitting the LibMsgque kernel into libmqmsgque and libmqmsgque the error is now splitted betweeen two and possible more packages. The solution was the introduction of the MkErrExtS entension technology.

Macro Definition Documentation

MqERROR

#define MqERROR   MqERROR_R(&MqRuntimeRLS)

Definition at line 2987 of file LibMqMsgque_mq.h.

MqERROR_O

#define MqERROR_O

(

o

)

Value:

MqERROR_R(MqRT_O(o))

Definition at line 2984 of file LibMqMsgque_mq.h.

MqERROR_R

#define MqERROR_R

(

r

)

Value:

((*r).error_mq)

Definition at line 2982 of file LibMqMsgque_mq.h.

MqERROR_RT

#define MqERROR_RT   MqERROR_R(&MQ_RT_REF)

Definition at line 2983 of file LibMqMsgque_mq.h.

MqERROR_X

#define MqERROR_X

(

x

)

Value:

MqERROR_R(MqRT_X(x))

Definition at line 2985 of file LibMqMsgque_mq.h.

MqERROR_XN

#define MqERROR_XN

(

x

)

Value:

MqERROR_R(MqRT_XN(x))

Definition at line 2986 of file LibMqMsgque_mq.h.

Function Documentation

MqErrorEnvReset()

void MqErrorEnvReset

(

MQ_ERR const

err

)

reset the MqErrorS::client_protect and the MqErrorS::server_protect …

void
MqErrorEnvReset (MQ_ERR const err)
{
  MK_INSTANCE_HDL(err);
  err->client_protect = protectINIT;
  err->server_protect = protectINIT;
}

Parameters

[in]

err

the MkErrorS instance to work on - the default-error is automatically created on startup. (NULL allowed)