libmqmsgque 9.0
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Functions
MqContextC_ConfigApi_Misc_C_API

various function to do 'misc' work with a MqContextCMore...

+ Collaboration diagram for MqContextC_ConfigApi_Misc_C_API:

Data Structures

struct  MqIoUdsConfigS
 configure a context to use a uds-client-server-linkMore...
 
struct  MqIoTcpConfigS
 configure a context to use a tcp-client-server-linkMore...
 
struct  MqIoPipeConfigS
 configure a context to use a pipe-client-server-linkMore...
 
struct  MqIoLoopConfigS
 Configure a context to use a loop-client-server-link … More...
 
struct  MqIoInitConfigS
 configure a context to use a init-client-server-linkMore...
 
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(* MqCreateF) (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 …
 

Overload

#define MqConfigDup(...)   MqConfigDup_RT(MK_RT_CALL __VA_ARGS__)
 
#define MqConfigReset(...)   MqConfigReset_RT(MK_RT_CALL __VA_ARGS__)
 
#define MqSetupDup(...)   MqSetupDup_RT(MK_RT_CALL __VA_ARGS__)
 

Detailed Description

various function to do 'misc' work with a MqContextC

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 1158 of file msgque_mq.h.

◆ MQ_CALLBACK_CREATE_CALL

#define MQ_CALLBACK_CREATE_CALL   MK_RT_CALL mqctx, argv

Definition at line 1159 of file msgque_mq.h.

◆ MqConfigDup

#define MqConfigDup (   ...)    MqConfigDup_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 193 of file msgque_overload_mq.h.

◆ MqConfigReset

#define MqConfigReset (   ...)    MqConfigReset_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 194 of file msgque_overload_mq.h.

◆ MqSetupDup

#define MqSetupDup (   ...)    MqSetupDup_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 195 of file msgque_overload_mq.h.

Typedef Documentation

◆ MqCreateF

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]mkrtthe runtime environment
[in]ctxcontext configuration (NULL is not allowed)
[in,out]argsthis is the args buffer-list pointer

Definition at line 935 of file msgque_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 1168 of file msgque_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:

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