MqContextC_ConfigApi_Misc_C_API

MqContextC - various function to do 'misc' configuration … More...

Collaboration diagram for MqContextC_ConfigApi_Misc_C_API:

Data Structures
struct	MqIoUdsConfigS
	configure a context to use a uds-client-server-link … More...
struct	MqIoTcpConfigS
	configure a context to use a tcp-client-server-link … More...
struct	MqIoPipeConfigS
	configure a context to use a pipe-client-server-link … More...
struct	MqIoLoopConfigS
	Configure a context to use a loop-client-server-link … More...
struct	MqIoInitConfigS
	configure a context to use a init-client-server-link … More...
struct	MqIoConfigS
	Basic configuration of a context … More...
struct	MqConfigS
	end-user configuration data, also available as command-line options More...
struct	MqSetupS
	application-programmer configuration data More...

Macros
#define	MQ_CALLBACK_CREATE_ARGS   MK_RT_ARGS MQ_CTX const mqctx, MK_BFL const argv
#define	MQ_CALLBACK_CREATE_CALL   MK_RT_CALL mqctx, argv

Typedefs
typedef enum MkErrorE(*	MqCreateFLT) (MK_RT const mkrt, MQ_CTX const ctx, MK_BFL const args)
	the prototype for the ContextCreate function …
typedef void(*	MqDeleteF) (MQ_CTX const ctx)
	the prototype for a ContextDelete function …

Functions
MQ_EXTERN void	MqConfigReset_RT (MK_RT const mkrt, MQ_CTX const ctx)
	clean the MqContextS::config data
MQ_EXTERN void	MqConfigDup_RT (MK_RT const mkrt, MQ_CTX const to, MQ_CTX const from)
	copy the MqContextS::config data
MQ_EXTERN void	MqSetupDup_RT (MK_RT const mkrt, MQ_CTX const to, MQ_CTXN const from)
	copy the MqContextS::setup data …

MqContextC - MqContextC_ConfigApi_Misc_C_API - overload
#define	MqConfigDup_NULL(...)
#define	MqConfigDup(...)
#define	MqConfigReset_NULL(...)
#define	MqConfigReset(...)
#define	MqSetupDup_NULL(...)
#define	MqSetupDup(...)

Detailed Description

MqContextC - various function to do 'misc' configuration …

Macro Definition Documentation

MQ_CALLBACK_CREATE_ARGS

#define MQ_CALLBACK_CREATE_ARGS   MK_RT_ARGS MQ_CTX const mqctx, MK_BFL const argv

Definition at line 1167 of file LibMqMsgque_mq.h.

MQ_CALLBACK_CREATE_CALL

#define MQ_CALLBACK_CREATE_CALL   MK_RT_CALL mqctx, argv

Definition at line 1168 of file LibMqMsgque_mq.h.

MqConfigDup

#define MqConfigDup

(

...

)

Value:

MqConfigDup_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 105 of file msgque_overload_mq.h.

MqConfigDup_NULL

#define MqConfigDup_NULL

(

...

)

Value:

MqConfigDup_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 104 of file msgque_overload_mq.h.

MqConfigReset

#define MqConfigReset

(

...

)

Value:

MqConfigReset_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 107 of file msgque_overload_mq.h.

MqConfigReset_NULL

#define MqConfigReset_NULL

(

...

)

Value:

MqConfigReset_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 106 of file msgque_overload_mq.h.

MqSetupDup

#define MqSetupDup

(

...

)

Value:

MqSetupDup_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 109 of file msgque_overload_mq.h.

MqSetupDup_NULL

#define MqSetupDup_NULL

(

...

)

Value:

MqSetupDup_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 108 of file msgque_overload_mq.h.

Typedef Documentation

MqCreateFLT

typedef enum MkErrorE( * MqCreateFLT) (MK_RT const mkrt, MQ_CTX const ctx, MK_BFL const args)

the prototype for the ContextCreate function …

This function is the MqContextS::fCreate and MqContextS::fThreadCreate parameter and is used to :

1. create a child context
2. create a parent context as the thread entry point

Parameters

[in]	mkrt	the runtime environment
[in]	ctx	context configuration (NULL is not allowed)
	args	[in,out] this is the args buffer-list pointer

Definition at line 950 of file LibMqMsgque_mq.h.

MqDeleteF

typedef void( * MqDeleteF) (MQ_CTX const ctx)

the prototype for a ContextDelete function …

This function is the MqContextS::fDelete and MqContextS::fThreadDelete parameter and is used to:

1. delete a child context
2. delete a parent context at the thread exit point

Definition at line 1177 of file LibMqMsgque_mq.h.

Function Documentation

MqConfigDup_RT()

MQ_EXTERN void MqConfigDup_RT	(	MK_RT const	mkrt,
		MQ_CTX const	to,
		MQ_CTX const	from )

copy the MqContextS::config data

MqConfigReset_RT()

MQ_EXTERN void MqConfigReset_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx )

clean the MqContextS::config data

MqSetupDup_RT()

MQ_EXTERN void MqSetupDup_RT	(	MK_RT const	mkrt,
		MQ_CTX const	to,
		MQ_CTXN const	from )

copy the MqContextS::setup data …

MqSetupDup is an important function, because every new created object need to fill the MqSetupS data. The typical software flow is:

• Call-Factory -> MqContextCreate (default setup) -> Object-Specific-Setup -> MqSetupDup

MqSetupDup has code to protect setup data filled in Object-Specific-Setup