Loading...
Searching...
No Matches
MqContextC_LogApi_C_API

MqContextC - log the output to a string or a MkLogFileCMore...

+ Collaboration diagram for MqContextC_LogApi_C_API:

Functions

MQ_EXTERN void libmqmsgque::MqContextLog_RT (MK_RT const mkrt, MQ_CTXN const ctx, MK_OBJN fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl)
 log the MqContextC
 
MQ_EXTERN void libmqmsgque::MqContextLogShort_RT (MK_RT const mkrt, MQ_CTXN const ctx, MK_OBJN fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl, MK_STRN const label)
 log the MqContextC with less info then MqContextLog
 
MQ_EXTERN void libmqmsgque::MqContextLogConfig_RT (MK_RT const mkrt, MQ_CTXN const ctx, MK_OBJN fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl)
 log the MqContextC part libmqmsgque::MqConfigS
 
MQ_EXTERN void libmqmsgque::MqContextLogSetup_RT (MK_RT const mkrt, MQ_CTXN const ctx, MK_OBJN fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl)
 log the MqContextC part libmqmsgque::MqSetupS
 
MQ_EXTERN void libmqmsgque::MqContextLogLink_RT (MK_RT const mkrt, MQ_CTXN ctx, MK_OBJN const fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl)
 log the MqContextC part libmqmsgque::MqLinkS
 
MQ_EXTERN void libmqmsgque::MqContextLogEnv_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_OBJ const fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl)
 log the MqContextC part libmqmsgque::MqEnvS
 
MQ_EXTERN void libmqmsgque::MqContextLogType_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_OBJ fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl)
 log the MqContextC part MkTypeS
 
MQ_EXTERN void libmqmsgque::MqContextLogDebug (MQ_CTX const ctx)
 
MK_ATTR_HDL MK_STRN libmqmsgque::MqLogServerOrClient (MQ_CTXN const ctx)
 is ctx a SERVER or a CLIENT ? …
 
MK_ATTR_HDL MK_STRN libmqmsgque::MqLogParentOrChild (MQ_CTXN ctx)
 is ctx a PARENT or a CHILD ? …
 

MqContextC - MqContextC_LogApi_Log_C_API - overload

#define MqContextLog_NULL(...)
 
#define MqContextLog(...)
 
#define MqContextLog_4(ctx, fmtobj, debug, callfunc)
 
#define MqContextLog_3(ctx, fmtobj, debug)
 
#define MqContextLog_2(ctx, fmtobj)
 
#define MqContextLog_1(ctx)
 
#define MqContextLogConfig_NULL(...)
 
#define MqContextLogConfig(...)
 
#define MqContextLogConfig_4(ctx, fmtobj, debug, callfunc)
 
#define MqContextLogConfig_3(ctx, fmtobj, debug)
 
#define MqContextLogConfig_2(ctx, fmtobj)
 
#define MqContextLogConfig_1(ctx)
 
#define MqContextLogEnv_NULL(...)
 
#define MqContextLogEnv(...)
 
#define MqContextLogEnv_4(ctx, fmtobj, debug, callfunc)
 
#define MqContextLogEnv_3(ctx, fmtobj, debug)
 
#define MqContextLogEnv_2(ctx, fmtobj)
 
#define MqContextLogEnv_1(ctx)
 
#define MqContextLogLink_NULL(...)
 
#define MqContextLogLink(...)
 
#define MqContextLogLink_4(ctx, fmtobj, debug, callfunc)
 
#define MqContextLogLink_3(ctx, fmtobj, debug)
 
#define MqContextLogLink_2(ctx, fmtobj)
 
#define MqContextLogLink_1(ctx)
 
#define MqContextLogSetup_NULL(...)
 
#define MqContextLogSetup(...)
 
#define MqContextLogSetup_4(ctx, fmtobj, debug, callfunc)
 
#define MqContextLogSetup_3(ctx, fmtobj, debug)
 
#define MqContextLogSetup_2(ctx, fmtobj)
 
#define MqContextLogSetup_1(ctx)
 
#define MqContextLogShort_NULL(...)
 
#define MqContextLogShort(...)
 
#define MqContextLogShort_5(ctx, fmtobj, debug, callfunc, lvl)
 
#define MqContextLogShort_4(ctx, fmtobj, debug, callfunc)
 
#define MqContextLogShort_3(ctx, fmtobj, debug)
 
#define MqContextLogShort_2(ctx, fmtobj)
 
#define MqContextLogShort_1(ctx)
 
#define MqContextLogType_NULL(...)
 
#define MqContextLogType(...)
 
#define MqContextLogType_4(ctx, fmtobj, debug, callfunc)
 
#define MqContextLogType_3(ctx, fmtobj, debug)
 
#define MqContextLogType_2(ctx, fmtobj)
 
#define MqContextLogType_1(ctx)
 

Detailed Description

MqContextC - log the output to a string or a MkLogFileC

Logging is an important part of the debugging and validation task.

The logging target is set with MkRuntimeSetLogfile wich accepts a filename or the special token stdout or stderr.

Many logging functions have common parameters:

Parameters
[in]fmtobjmanaged object used to format the log-message (default=MK_NULL → use default-format)
[in]callfunca user-defined postfix to identify the calling function or the environment (default=name-of-function)
[in]debugthe debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)

Macro Definition Documentation

◆ MqContextLog

#define MqContextLog ( ...)
Value:
MqContextLog_RT(MK_RT_CALL __VA_ARGS__)
#define MK_RT_CALL

Definition at line 250 of file msgque_overload_mq.h.

◆ MqContextLog_1

#define MqContextLog_1 ( ctx)
Value:
MqContextLog(ctx,NULL,0,__func__,0)
#define MqContextLog(...)

Definition at line 254 of file msgque_overload_mq.h.

◆ MqContextLog_2

#define MqContextLog_2 ( ctx,
fmtobj )
Value:
MqContextLog(ctx,fmtobj,0,__func__,0)

Definition at line 253 of file msgque_overload_mq.h.

◆ MqContextLog_3

#define MqContextLog_3 ( ctx,
fmtobj,
debug )
Value:
MqContextLog(ctx,fmtobj,debug,__func__,0)

Definition at line 252 of file msgque_overload_mq.h.

◆ MqContextLog_4

#define MqContextLog_4 ( ctx,
fmtobj,
debug,
callfunc )
Value:
MqContextLog(ctx,fmtobj,debug,callfunc,0)

Definition at line 251 of file msgque_overload_mq.h.

◆ MqContextLog_NULL

#define MqContextLog_NULL ( ...)
Value:
MqContextLog_RT(MK_RT_CALL_NULL __VA_ARGS__)
#define MK_RT_CALL_NULL

Definition at line 249 of file msgque_overload_mq.h.

◆ MqContextLogConfig

#define MqContextLogConfig ( ...)
Value:
MqContextLogConfig_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 256 of file msgque_overload_mq.h.

◆ MqContextLogConfig_1

#define MqContextLogConfig_1 ( ctx)
Value:
MqContextLogConfig(ctx,NULL,0,__func__,0)
#define MqContextLogConfig(...)

Definition at line 260 of file msgque_overload_mq.h.

◆ MqContextLogConfig_2

#define MqContextLogConfig_2 ( ctx,
fmtobj )
Value:
MqContextLogConfig(ctx,fmtobj,0,__func__,0)

Definition at line 259 of file msgque_overload_mq.h.

◆ MqContextLogConfig_3

#define MqContextLogConfig_3 ( ctx,
fmtobj,
debug )
Value:
MqContextLogConfig(ctx,fmtobj,debug,__func__,0)

Definition at line 258 of file msgque_overload_mq.h.

◆ MqContextLogConfig_4

#define MqContextLogConfig_4 ( ctx,
fmtobj,
debug,
callfunc )
Value:
MqContextLogConfig(ctx,fmtobj,debug,callfunc,0)

Definition at line 257 of file msgque_overload_mq.h.

◆ MqContextLogConfig_NULL

#define MqContextLogConfig_NULL ( ...)
Value:
MqContextLogConfig_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 255 of file msgque_overload_mq.h.

◆ MqContextLogEnv

#define MqContextLogEnv ( ...)
Value:
MqContextLogEnv_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 262 of file msgque_overload_mq.h.

◆ MqContextLogEnv_1

#define MqContextLogEnv_1 ( ctx)
Value:
MqContextLogEnv(ctx,NULL,0,__func__,0)
#define MqContextLogEnv(...)

Definition at line 266 of file msgque_overload_mq.h.

◆ MqContextLogEnv_2

#define MqContextLogEnv_2 ( ctx,
fmtobj )
Value:
MqContextLogEnv(ctx,fmtobj,0,__func__,0)

Definition at line 265 of file msgque_overload_mq.h.

◆ MqContextLogEnv_3

#define MqContextLogEnv_3 ( ctx,
fmtobj,
debug )
Value:
MqContextLogEnv(ctx,fmtobj,debug,__func__,0)

Definition at line 264 of file msgque_overload_mq.h.

◆ MqContextLogEnv_4

#define MqContextLogEnv_4 ( ctx,
fmtobj,
debug,
callfunc )
Value:
MqContextLogEnv(ctx,fmtobj,debug,callfunc,0)

Definition at line 263 of file msgque_overload_mq.h.

◆ MqContextLogEnv_NULL

#define MqContextLogEnv_NULL ( ...)
Value:
MqContextLogEnv_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 261 of file msgque_overload_mq.h.

◆ MqContextLogLink

#define MqContextLogLink ( ...)
Value:
MqContextLogLink_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 268 of file msgque_overload_mq.h.

◆ MqContextLogLink_1

#define MqContextLogLink_1 ( ctx)
Value:
MqContextLogLink(ctx,NULL,0,__func__,0)
#define MqContextLogLink(...)

Definition at line 272 of file msgque_overload_mq.h.

◆ MqContextLogLink_2

#define MqContextLogLink_2 ( ctx,
fmtobj )
Value:
MqContextLogLink(ctx,fmtobj,0,__func__,0)

Definition at line 271 of file msgque_overload_mq.h.

◆ MqContextLogLink_3

#define MqContextLogLink_3 ( ctx,
fmtobj,
debug )
Value:
MqContextLogLink(ctx,fmtobj,debug,__func__,0)

Definition at line 270 of file msgque_overload_mq.h.

◆ MqContextLogLink_4

#define MqContextLogLink_4 ( ctx,
fmtobj,
debug,
callfunc )
Value:
MqContextLogLink(ctx,fmtobj,debug,callfunc,0)

Definition at line 269 of file msgque_overload_mq.h.

◆ MqContextLogLink_NULL

#define MqContextLogLink_NULL ( ...)
Value:
MqContextLogLink_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 267 of file msgque_overload_mq.h.

◆ MqContextLogSetup

#define MqContextLogSetup ( ...)
Value:
MqContextLogSetup_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 274 of file msgque_overload_mq.h.

◆ MqContextLogSetup_1

#define MqContextLogSetup_1 ( ctx)
Value:
MqContextLogSetup(ctx,NULL,0,__func__,0)
#define MqContextLogSetup(...)

Definition at line 278 of file msgque_overload_mq.h.

◆ MqContextLogSetup_2

#define MqContextLogSetup_2 ( ctx,
fmtobj )
Value:
MqContextLogSetup(ctx,fmtobj,0,__func__,0)

Definition at line 277 of file msgque_overload_mq.h.

◆ MqContextLogSetup_3

#define MqContextLogSetup_3 ( ctx,
fmtobj,
debug )
Value:
MqContextLogSetup(ctx,fmtobj,debug,__func__,0)

Definition at line 276 of file msgque_overload_mq.h.

◆ MqContextLogSetup_4

#define MqContextLogSetup_4 ( ctx,
fmtobj,
debug,
callfunc )
Value:
MqContextLogSetup(ctx,fmtobj,debug,callfunc,0)

Definition at line 275 of file msgque_overload_mq.h.

◆ MqContextLogSetup_NULL

#define MqContextLogSetup_NULL ( ...)
Value:
MqContextLogSetup_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 273 of file msgque_overload_mq.h.

◆ MqContextLogShort

#define MqContextLogShort ( ...)
Value:
MqContextLogShort_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 280 of file msgque_overload_mq.h.

◆ MqContextLogShort_1

#define MqContextLogShort_1 ( ctx)
Value:
MqContextLogShort(ctx,NULL,0,__func__,0,NULL)
#define MqContextLogShort(...)

Definition at line 285 of file msgque_overload_mq.h.

◆ MqContextLogShort_2

#define MqContextLogShort_2 ( ctx,
fmtobj )
Value:
MqContextLogShort(ctx,fmtobj,0,__func__,0,NULL)

Definition at line 284 of file msgque_overload_mq.h.

◆ MqContextLogShort_3

#define MqContextLogShort_3 ( ctx,
fmtobj,
debug )
Value:
MqContextLogShort(ctx,fmtobj,debug,__func__,0,NULL)

Definition at line 283 of file msgque_overload_mq.h.

◆ MqContextLogShort_4

#define MqContextLogShort_4 ( ctx,
fmtobj,
debug,
callfunc )
Value:
MqContextLogShort(ctx,fmtobj,debug,callfunc,0,NULL)

Definition at line 282 of file msgque_overload_mq.h.

◆ MqContextLogShort_5

#define MqContextLogShort_5 ( ctx,
fmtobj,
debug,
callfunc,
lvl )
Value:
MqContextLogShort(ctx,fmtobj,debug,callfunc,lvl,NULL)

Definition at line 281 of file msgque_overload_mq.h.

◆ MqContextLogShort_NULL

#define MqContextLogShort_NULL ( ...)
Value:
MqContextLogShort_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 279 of file msgque_overload_mq.h.

◆ MqContextLogType

#define MqContextLogType ( ...)
Value:
MqContextLogType_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 287 of file msgque_overload_mq.h.

◆ MqContextLogType_1

#define MqContextLogType_1 ( ctx)
Value:
MqContextLogType(ctx,NULL,0,__func__,0)
#define MqContextLogType(...)

Definition at line 291 of file msgque_overload_mq.h.

◆ MqContextLogType_2

#define MqContextLogType_2 ( ctx,
fmtobj )
Value:
MqContextLogType(ctx,fmtobj,0,__func__,0)

Definition at line 290 of file msgque_overload_mq.h.

◆ MqContextLogType_3

#define MqContextLogType_3 ( ctx,
fmtobj,
debug )
Value:
MqContextLogType(ctx,fmtobj,debug,__func__,0)

Definition at line 289 of file msgque_overload_mq.h.

◆ MqContextLogType_4

#define MqContextLogType_4 ( ctx,
fmtobj,
debug,
callfunc )
Value:
MqContextLogType(ctx,fmtobj,debug,callfunc,0)

Definition at line 288 of file msgque_overload_mq.h.

◆ MqContextLogType_NULL

#define MqContextLogType_NULL ( ...)
Value:
MqContextLogType_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 286 of file msgque_overload_mq.h.

Function Documentation

◆ MqContextLog_RT()

MQ_EXTERN void libmqmsgque::MqContextLog_RT ( MK_RT const mkrt,
MQ_CTXN const ctx,
MK_OBJN fmtobj,
MK_DBG const debug,
MK_STRN const callfunc,
MK_I32 const lvl )

log the MqContextC

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
[in]fmtobjmanaged object used to format the log-message (default=MK_NULL → use default-format)
[in]debugthe debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)
[in]callfunca user-defined postfix to identify the calling function or the environment (default=name-of-function)
[in]lvla user-defined prefix starting with "" for lvl=0 and increase with " " for lvl+1 (default=0)
See also
MqContextC_C_API MqContextLogShort

◆ MqContextLogConfig_RT()

MQ_EXTERN void libmqmsgque::MqContextLogConfig_RT ( MK_RT const mkrt,
MQ_CTXN const ctx,
MK_OBJN fmtobj,
MK_DBG const debug,
MK_STRN const callfunc,
MK_I32 const lvl )

log the MqContextC part libmqmsgque::MqConfigS

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
[in]fmtobjmanaged object used to format the log-message (default=MK_NULL → use default-format)
[in]debugthe debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)
[in]callfunca user-defined postfix to identify the calling function or the environment (default=name-of-function)
[in]lvla user-defined prefix starting with "" for lvl=0 and increase with " " for lvl+1 (default=0)

◆ MqContextLogDebug()

MQ_EXTERN void libmqmsgque::MqContextLogDebug ( MQ_CTX const ctx)

◆ MqContextLogEnv_RT()

MQ_EXTERN void libmqmsgque::MqContextLogEnv_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_OBJ const fmtobj,
MK_DBG const debug,
MK_STRN const callfunc,
MK_I32 const lvl )

log the MqContextC part libmqmsgque::MqEnvS

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
[in]fmtobjmanaged object used to format the log-message (default=MK_NULL → use default-format)
[in]debugthe debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)
[in]callfunca user-defined postfix to identify the calling function or the environment (default=name-of-function)
[in]lvla user-defined prefix starting with "" for lvl=0 and increase with " " for lvl+1 (default=0)
See also
MqContextC_EnvApi_C_API

◆ MqContextLogLink_RT()

MQ_EXTERN void libmqmsgque::MqContextLogLink_RT ( MK_RT const mkrt,
MQ_CTXN ctx,
MK_OBJN const fmtobj,
MK_DBG const debug,
MK_STRN const callfunc,
MK_I32 const lvl )

log the MqContextC part libmqmsgque::MqLinkS

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
[in]fmtobjmanaged object used to format the log-message (default=MK_NULL → use default-format)
[in]debugthe debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)
[in]callfunca user-defined postfix to identify the calling function or the environment (default=name-of-function)
[in]lvla user-defined prefix starting with "" for lvl=0 and increase with " " for lvl+1 (default=0)

◆ MqContextLogSetup_RT()

MQ_EXTERN void libmqmsgque::MqContextLogSetup_RT ( MK_RT const mkrt,
MQ_CTXN const ctx,
MK_OBJN fmtobj,
MK_DBG const debug,
MK_STRN const callfunc,
MK_I32 const lvl )

log the MqContextC part libmqmsgque::MqSetupS

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
[in]fmtobjmanaged object used to format the log-message (default=MK_NULL → use default-format)
[in]debugthe debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)
[in]callfunca user-defined postfix to identify the calling function or the environment (default=name-of-function)
[in]lvla user-defined prefix starting with "" for lvl=0 and increase with " " for lvl+1 (default=0)

◆ MqContextLogShort_RT()

MQ_EXTERN void libmqmsgque::MqContextLogShort_RT ( MK_RT const mkrt,
MQ_CTXN const ctx,
MK_OBJN fmtobj,
MK_DBG const debug,
MK_STRN const callfunc,
MK_I32 const lvl,
MK_STRN const label )

log the MqContextC with less info then MqContextLog

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
[in]fmtobjmanaged object used to format the log-message (default=MK_NULL → use default-format)
[in]labela string to identify a task or object
[in]debugthe debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)
[in]callfunca user-defined postfix to identify the calling function or the environment (default=name-of-function)
[in]lvla user-defined prefix starting with "" for lvl=0 and increase with " " for lvl+1 (default=0)
See also
MqContextC_C_API MqContextLog

◆ MqContextLogType_RT()

MQ_EXTERN void libmqmsgque::MqContextLogType_RT ( MK_RT const mkrt,
MQ_CTX const ctx,
MK_OBJ fmtobj,
MK_DBG const debug,
MK_STRN const callfunc,
MK_I32 const lvl )

log the MqContextC part MkTypeS

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
[in]fmtobjmanaged object used to format the log-message (default=MK_NULL → use default-format)
[in]debugthe debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)
[in]callfunca user-defined postfix to identify the calling function or the environment (default=name-of-function)
[in]lvla user-defined prefix starting with "" for lvl=0 and increase with " " for lvl+1 (default=0)
See also
MqContextC_C_API MqContextLog

◆ MqLogParentOrChild()

MK_ATTR_HDL MK_STRN libmqmsgque::MqLogParentOrChild ( MQ_CTXN ctx)
inline

is ctx a PARENT or a CHILD ? …

Parameters
[in]ctxthe MqContextS instance to work on
Returns
the string PARENT or CHILD

Definition at line 9682 of file LibMqMsgque_mq.h.

9684 {
9685 MK_ATTR_HDL_CHECK(ctx);
9686 return (MQ_IS_PARENT (ctx) ? "PARENT" : "CHILD");
9687}
#define MQ_IS_PARENT(ctx)
+ Here is the caller graph for this function:

◆ MqLogServerOrClient()

MK_ATTR_HDL MK_STRN libmqmsgque::MqLogServerOrClient ( MQ_CTXN const ctx)
inline

is ctx a SERVER or a CLIENT ? …

Parameters
[in]ctxthe MqContextS instance to work on
Returns
the string SERVER or CLIENT

Definition at line 9671 of file LibMqMsgque_mq.h.

9673 {
9674 MK_ATTR_HDL_CHECK(ctx);
9675 return (MQ_IS_SERVER (ctx) ? "SERVER" : "CLIENT");
9676}
#define MQ_IS_SERVER(ctx)
extract boolean information from context
+ Here is the caller graph for this function: