MqContextC_Log_RB_API

MqContextC - log the output to a string or a MkLogFileC … More...

Collaboration diagram for MqContextC_Log_RB_API:

Functions
MK_DEPRECATED static MK_UNUSED OT_ProcRet	rbmqmsgque_MqContextC_Log (MqContextC_ARGS)
static OT_ProcRet	rbmqmsgque_MqContextC_LogConfig (MqContextC_ARGS)
	Ruby: ctx.LogConfig(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API log the MqContextC part MqConfigS …
static OT_ProcRet	rbmqmsgque_MqContextC_LogEnv (MqContextC_ARGS)
	Ruby: ctx.LogEnv(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API log the MqContextC part MqEnvS …
static OT_ProcRet	rbmqmsgque_MqContextC_LogLink (MqContextC_ARGS)
	Ruby: ctx.LogLink(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API log the MqContextC part MqLinkS …
static OT_ProcRet	rbmqmsgque_MqContextC_LogSetup (MqContextC_ARGS)
	Ruby: ctx.LogSetup(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API log the MqContextC part MqSetupS …
static OT_ProcRet	rbmqmsgque_MqContextC_LogShort (MqContextC_ARGS)
	Ruby: ctx.LogShort(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?, ?label:string="nil"?) → C-API log the MqContextC with less info then MqContextLog …
static OT_ProcRet	rbmqmsgque_MqContextC_LogType (MqContextC_ARGS)
	Ruby: ctx.LogType(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API log the MqContextC part MkTypeS …
static OT_ProcRet	rbmqmsgque_MqContextC_LogParentOrChild (MqContextC_ARGS)
	Ruby: string ctx.LogParentOrChild() → C-API is ctx a PARENT or a CHILD ? …
static OT_ProcRet	rbmqmsgque_MqContextC_LogServerOrClient (MqContextC_ARGS)
	Ruby: string ctx.LogServerOrClient() → C-API is ctx a SERVER or a CLIENT ? …

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 MkRuntimeLogTargetSet wich accepts a filename or the special token stdout or stderr.

Many logging functions have common parameters:

Parameters

[in]	fmtobj	managed object used to format the log-message (default=nil → use default-format)
[in]	callfunc	a user-defined postfix to identify the calling-function or the environment (default = name-of-function, nil = resolve-own-name)
[in]	debug	the debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)

Function Documentation

rbmqmsgque_MqContextC_Log()

MK_DEPRECATED static MK_UNUSED OT_ProcRet rbmqmsgque_MqContextC_Log ( MqContextC_ARGS )

static

Definition at line 1330 of file MqContextC_rb.c.

{OT_ERROR_LNG_RETURN;}

rbmqmsgque_MqContextC_LogConfig()

static OT_ProcRet rbmqmsgque_MqContextC_LogConfig ( MqContextC_ARGS )

static

Ruby: ctx.LogConfig(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API
log the MqContextC part MqConfigS …

Definition at line 1333 of file MqContextC_rb.c.

                                                             {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,4,LogConfig_doc);
  MK_OBJN fmtobj = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_OBJN (fmtobj,MK_NULL_YES))
  MK_DBG debug = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (debug))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_I32 lvl = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (lvl))
  OT_CHECK_NOARGS;
  if (debug > MkRuntimeDebugGet()) {
    OT_retObj_SET_None;
    goto end;
  }
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MqContextLogConfig (hdl, fmtobj, debug, callfunc, lvl);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LogEnv()

static OT_ProcRet rbmqmsgque_MqContextC_LogEnv ( MqContextC_ARGS )

static

Ruby: ctx.LogEnv(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API
log the MqContextC part MqEnvS …

Definition at line 1358 of file MqContextC_rb.c.

                                                          {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,4,LogEnv_doc);
  MK_OBJN fmtobj = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_OBJN (fmtobj,MK_NULL_YES))
  MK_DBG debug = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (debug))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_I32 lvl = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (lvl))
  OT_CHECK_NOARGS;
  if (debug > MkRuntimeDebugGet()) {
    OT_retObj_SET_None;
    goto end;
  }
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MqContextLogEnv (hdl, fmtobj, debug, callfunc, lvl);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LogLink()

static OT_ProcRet rbmqmsgque_MqContextC_LogLink ( MqContextC_ARGS )

static

Ruby: ctx.LogLink(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API
log the MqContextC part MqLinkS …

Definition at line 1383 of file MqContextC_rb.c.

                                                           {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,4,LogLink_doc);
  MK_OBJN fmtobj = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_OBJN (fmtobj,MK_NULL_YES))
  MK_DBG debug = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (debug))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_I32 lvl = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (lvl))
  OT_CHECK_NOARGS;
  if (debug > MkRuntimeDebugGet()) {
    OT_retObj_SET_None;
    goto end;
  }
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MqContextLogLink (hdl, fmtobj, debug, callfunc, lvl);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LogParentOrChild()

static OT_ProcRet rbmqmsgque_MqContextC_LogParentOrChild ( MqContextC_ARGS )

static

Ruby: string ctx.LogParentOrChild() → C-API
is ctx a PARENT or a CHILD ? …

Definition at line 1485 of file MqContextC_rb.c.

                                                                    {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(LogParentOrChild_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_STR(MqLogParentOrChild (hdl));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LogServerOrClient()

static OT_ProcRet rbmqmsgque_MqContextC_LogServerOrClient ( MqContextC_ARGS )

static

Ruby: string ctx.LogServerOrClient() → C-API
is ctx a SERVER or a CLIENT ? …

Definition at line 1495 of file MqContextC_rb.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(LogServerOrClient_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_STR(MqLogServerOrClient (hdl));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LogSetup()

static OT_ProcRet rbmqmsgque_MqContextC_LogSetup ( MqContextC_ARGS )

static

Ruby: ctx.LogSetup(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API
log the MqContextC part MqSetupS …

Definition at line 1408 of file MqContextC_rb.c.

                                                            {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,4,LogSetup_doc);
  MK_OBJN fmtobj = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_OBJN (fmtobj,MK_NULL_YES))
  MK_DBG debug = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (debug))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_I32 lvl = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (lvl))
  OT_CHECK_NOARGS;
  if (debug > MkRuntimeDebugGet()) {
    OT_retObj_SET_None;
    goto end;
  }
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MqContextLogSetup (hdl, fmtobj, debug, callfunc, lvl);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LogShort()

static OT_ProcRet rbmqmsgque_MqContextC_LogShort ( MqContextC_ARGS )

static

Ruby: ctx.LogShort(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?, ?label:string="nil"?) → C-API
log the MqContextC with less info then MqContextLog …

Definition at line 1433 of file MqContextC_rb.c.

                                                            {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,5,LogShort_doc);
  MK_OBJN fmtobj = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_OBJN (fmtobj,MK_NULL_YES))
  MK_DBG debug = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (debug))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_I32 lvl = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (lvl))
  MK_STRN label = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (label))
  OT_CHECK_NOARGS;
  if (debug > MkRuntimeDebugGet()) {
    OT_retObj_SET_None;
    goto end;
  }
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MqContextLogShort (hdl, fmtobj, debug, callfunc, lvl, label);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LogType()

static OT_ProcRet rbmqmsgque_MqContextC_LogType ( MqContextC_ARGS )

static

Ruby: ctx.LogType(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API
log the MqContextC part MkTypeS …

Definition at line 1460 of file MqContextC_rb.c.

                                                           {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,4,LogType_doc);
  MK_OBJN fmtobj = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_OBJN (fmtobj,MK_NULL_YES))
  MK_DBG debug = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (debug))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MK_I32 lvl = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (lvl))
  OT_CHECK_NOARGS;
  if (debug > MkRuntimeDebugGet()) {
    OT_retObj_SET_None;
    goto end;
  }
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MqContextLogType (hdl, fmtobj, debug, callfunc, lvl);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}