MkObjectC_Log_RB_API

MkObjectC - log information to MkLogFileC (default: stderr) … More...

Collaboration diagram for MkObjectC_Log_RB_API:

Functions
static OT_ProcRet	rbmkkernel_MkObjectC_LogC (MkObjectC_ARGS)
	Ruby: fmtobj.LogC(message:string, ?debug:int32=0?, ?callfunc:string="MK_NULL"?) → C-API write a logging-message to MkLogFileC (default: stderr) using the internal format …
static OT_ProcRet	rbmkkernel_MkObjectC_LogHEX (MkObjectC_ARGS)
	Ruby: fmtobj.LogHEX(callfunc:string, data:binary) → C-API log binaray data as HEX into the MkLogFileC (default: stderr) …
static OT_ProcRet	rbmkkernel_MkObjectC_Log (MkObjectC_ARGS)
	Ruby: obj.Log(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API Log-Slot - log a summary of an object to the MkLogFileC (default: stderr) target …
static OT_ProcRet	rbmkkernel_MkObjectC_LogLong (MkObjectC_ARGS)
	Ruby: obj.LogLong(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API log the MkObjectS verbose into the MkLogFileC (default: stderr) …
static OT_ProcRet	rbmkkernel_MkObjectC_LogShort (MkObjectC_ARGS)
	Ruby: obj.LogShort(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API log the MkObjectS into the MkLogFileC (default: stderr) …
static OT_ProcRet	rbmkkernel_MkObjectC_LogType (MkObjectC_ARGS)
	Ruby: obj.LogType(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API log the tyoe of the MkObjectS into the MkLogFileC (default: stderr) …

Detailed Description

MkObjectC - log information to MkLogFileC (default: stderr) …

The logging-target is set direct by RuntimeLogTargetSet or using the class MkLogFileC.

The target is stored at the MkRuntimeC using a FILE-stream and can be set individually for each thread. The default is stderr.

• the handle is stored at MkLogDataS::logFILE
• the filename (if available) is stored at MkRuntimeS::log

possible values are:

value	decription	OS man-page
stdout	the standart output	stdio(3)
stderr	the standart error output	stdio(3)
fileName	an arbitary fileName	fopen(3)

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

rbmkkernel_MkObjectC_Log()

static OT_ProcRet rbmkkernel_MkObjectC_Log ( MkObjectC_ARGS )

static

Ruby: obj.Log(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API
Log-Slot - log a summary of an object to the MkLogFileC (default: stderr) target …

Definition at line 535 of file MkObjectC_rb.c.

                                                     {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,4,Log_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;}
  MkObjectLog (hdl, fmtobj, debug, callfunc, lvl);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

rbmkkernel_MkObjectC_LogC()

static OT_ProcRet rbmkkernel_MkObjectC_LogC ( MkObjectC_ARGS )

static

Ruby: fmtobj.LogC(message:string, ?debug:int32=0?, ?callfunc:string="MK_NULL"?) → C-API
write a logging-message to MkLogFileC (default: stderr) using the internal format …

Definition at line 495 of file MkObjectC_rb.c.

                                                      {
  OT_SETUP_hdl__null_allow;
  OT_SETUP_VARARGS(1,3,LogC_doc);
  MK_STRN message = 0;
  OT_CHECK_REQUIRED(OT_CHECK_STRN (message))
  MK_DBG debug = 0;
  OT_CHECK_OPTIONAL(OT_CHECK_NI4 (debug))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  OT_CHECK_NOARGS;
  if (debug > MkRuntimeDebugGet()) {
    OT_retObj_SET_None;
    goto end;
  }
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MkLogC (hdl, message, debug, callfunc);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

rbmkkernel_MkObjectC_LogHEX()

static OT_ProcRet rbmkkernel_MkObjectC_LogHEX ( MkObjectC_ARGS )

static

Ruby: fmtobj.LogHEX(callfunc:string, data:binary) → C-API
log binaray data as HEX into the MkLogFileC (default: stderr) …

Definition at line 518 of file MkObjectC_rb.c.

                                                        {
  OT_SETUP_hdl__null_allow;
  OT_SETUP_VARARGS(1,2,LogHEX_doc);
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  MkBinaryR data = {0};
  OT_CHECK_REQUIRED(OT_CHECK__ME_REF_MkBinaryR(data))
  OT_CHECK_NOARGS;
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MkLogHEX (hdl, callfunc, data);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

rbmkkernel_MkObjectC_LogLong()

static OT_ProcRet rbmkkernel_MkObjectC_LogLong ( MkObjectC_ARGS )

static

Ruby: obj.LogLong(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API
log the MkObjectS verbose into the MkLogFileC (default: stderr) …

Definition at line 560 of file MkObjectC_rb.c.

                                                         {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,4,LogLong_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;}
  MkObjectLogLong (hdl, fmtobj, debug, callfunc, lvl);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

rbmkkernel_MkObjectC_LogShort()

static OT_ProcRet rbmkkernel_MkObjectC_LogShort ( MkObjectC_ARGS )

static

Ruby: obj.LogShort(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API
log the MkObjectS into the MkLogFileC (default: stderr) …

Definition at line 585 of file MkObjectC_rb.c.

                                                          {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,4,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))
  OT_CHECK_NOARGS;
  if (debug > MkRuntimeDebugGet()) {
    OT_retObj_SET_None;
    goto end;
  }
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MkObjectLogShort (hdl, fmtobj, debug, callfunc, lvl);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

rbmkkernel_MkObjectC_LogType()

static OT_ProcRet rbmkkernel_MkObjectC_LogType ( MkObjectC_ARGS )

static

Ruby: obj.LogType(?fmtobj:MkObjectC=nil?, ?debug:int32=0?, ?callfunc:string="MK_NULL"?, ?lvl:int32=0?) → C-API
log the tyoe of the MkObjectS into the MkLogFileC (default: stderr) …

Definition at line 610 of file MkObjectC_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;}
  MkObjectLogType (hdl, fmtobj, debug, callfunc, lvl);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}