MkErrorC_Signal_TCL_API

MkErrorC - various functions to set and check a 'signal' on a MkErrorS … More...

Collaboration diagram for MkErrorC_Signal_TCL_API:

Functions
static OT_ProcRet	tclmkkernel_MkErrorC_IsABORT (MkErrorC_ARGS)
	Tcl: bool [$err IsABORT] → C-API check on ABORT signal …
static OT_ProcRet	tclmkkernel_MkErrorC_IsEXIT (MkErrorC_ARGS)
	Tcl: bool [$err IsEXIT] → C-API check on APPLICATION-EXIT error …
static OT_ProcRet	tclmkkernel_MkErrorC_IsSOCKET (MkErrorC_ARGS)
	Tcl: bool [$err IsSOCKET] → C-API check on SOCKET-DOWN error …
static OT_ProcRet	tclmkkernel_MkErrorC_IsTIMEOUT (MkErrorC_ARGS)
	Tcl: bool [$err IsTIMEOUT] → C-API check on TIMEOUT error …
static OT_ProcRet	tclmkkernel_MkErrorC_SetABORT (MkErrorC_ARGS)
	Tcl: $err SetABORT ?detail:string="UNKNOWN"? ?callfunc:string="MK_NULL"? → C-API send the ABORT signal to the calling stack…
static OT_ProcRet	tclmkkernel_MkErrorC_SetCONTINUE (MkErrorC_ARGS)
	Tcl: $err SetCONTINUE → C-API signal end of processing in an MqMqEventIF callback …
static OT_ProcRet	tclmkkernel_MkErrorC_SetCode (MkErrorC_ARGS)
	Tcl: $err SetCode code:MkErrorE → C-API set the MkErrorS::code value …
static OT_ProcRet	tclmkkernel_MkErrorC_SetEXIT (MkErrorC_ARGS)
	Tcl: $err SetEXIT ?callfunc:string="MK_NULL"? → C-API finish the current callback, return to toplevel and MqExit the application …
static OT_ProcRet	tclmkkernel_MkErrorC_SetSOCKET (MkErrorC_ARGS)
	Tcl: $err SetSOCKET ?detail:string="UNKNOWN"? ?callfunc:string="MK_NULL"? → C-API create SOCKET-DOWN error …

Detailed Description

MkErrorC - various functions to set and check a 'signal' on a MkErrorS …

Function Documentation

tclmkkernel_MkErrorC_IsABORT()

static OT_ProcRet tclmkkernel_MkErrorC_IsABORT ( MkErrorC_ARGS )

static

Tcl: bool [$err IsABORT] → C-API
check on ABORT signal …

Definition at line 639 of file MkErrorC_tcl.c.

                                                       {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(IsABORT_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_BOL(MkErrorIsABORT (hdl));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_IsEXIT()

static OT_ProcRet tclmkkernel_MkErrorC_IsEXIT ( MkErrorC_ARGS )

static

Tcl: bool [$err IsEXIT] → C-API
check on APPLICATION-EXIT error …

Definition at line 652 of file MkErrorC_tcl.c.

                                                      {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(IsEXIT_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_BOL(MkErrorIsEXIT (hdl));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_IsSOCKET()

static OT_ProcRet tclmkkernel_MkErrorC_IsSOCKET ( MkErrorC_ARGS )

static

Tcl: bool [$err IsSOCKET] → C-API
check on SOCKET-DOWN error …

Definition at line 665 of file MkErrorC_tcl.c.

                                                        {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(IsSOCKET_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_BOL(MkErrorIsSOCKET (hdl));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_IsTIMEOUT()

static OT_ProcRet tclmkkernel_MkErrorC_IsTIMEOUT ( MkErrorC_ARGS )

static

Tcl: bool [$err IsTIMEOUT] → C-API
check on TIMEOUT error …

Definition at line 678 of file MkErrorC_tcl.c.

                                                         {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(IsTIMEOUT_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_BOL(MkErrorIsTIMEOUT (hdl));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_SetABORT()

static OT_ProcRet tclmkkernel_MkErrorC_SetABORT ( MkErrorC_ARGS )

static

Tcl: $err SetABORT ?detail:string="UNKNOWN"? ?callfunc:string="MK_NULL"? → C-API
send the ABORT signal to the calling stack…

Definition at line 691 of file MkErrorC_tcl.c.

                                                        {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,2,SetABORT_doc);
  MK_STRN detail = "UNKNOWN";
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (detail))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  OT_CHECK_NOARGS;
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MkErrorC_Check(hdl,MkErrorSetABORT (hdl, detail, callfunc));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_SetCode()

static OT_ProcRet tclmkkernel_MkErrorC_SetCode ( MkErrorC_ARGS )

static

Tcl: $err SetCode code:MkErrorE → C-API
set the MkErrorS::code value …

Definition at line 725 of file MkErrorC_tcl.c.

                                                       {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(SetCode_doc);
  enum MkErrorE code = 0;
  OT_CHECK_REQUIRED(OT_CHECK_ENUM (MkErrorE,code))
  OT_CHECK_NOARGS;
  MkErrorSetCode (hdl, code);
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_SetCONTINUE()

static OT_ProcRet tclmkkernel_MkErrorC_SetCONTINUE ( MkErrorC_ARGS )

static

Tcl: $err SetCONTINUE → C-API
signal end of processing in an MqMqEventIF callback …

Definition at line 711 of file MkErrorC_tcl.c.

                                                           {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(SetCONTINUE_doc);
  OT_CHECK_NOARGS;
  MkErrorSetCONTINUE (hdl);
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_SetEXIT()

static OT_ProcRet tclmkkernel_MkErrorC_SetEXIT ( MkErrorC_ARGS )

static

Tcl: $err SetEXIT ?callfunc:string="MK_NULL"? → C-API
finish the current callback, return to toplevel and MqExit the application …

Definition at line 741 of file MkErrorC_tcl.c.

                                                       {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,1,SetEXIT_doc);
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  OT_CHECK_NOARGS;
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MkErrorC_Check(hdl,MkErrorSetEXIT (hdl, callfunc));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}

tclmkkernel_MkErrorC_SetSOCKET()

static OT_ProcRet tclmkkernel_MkErrorC_SetSOCKET ( MkErrorC_ARGS )

static

Tcl: $err SetSOCKET ?detail:string="UNKNOWN"? ?callfunc:string="MK_NULL"? → C-API
create SOCKET-DOWN error …

Definition at line 759 of file MkErrorC_tcl.c.

                                                         {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,2,SetSOCKET_doc);
  MK_STRN detail = "UNKNOWN";
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (detail))
  MK_STRN callfunc = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_STRN (callfunc))
  OT_CHECK_NOARGS;
  if (MkSysStringIsNULL(callfunc)) {callfunc = OT_GET_CALL_PROC;}
  MkErrorC_Check(hdl,MkErrorSetSOCKET (hdl, detail, callfunc));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_FRAME_CLEANUP;
  OT_retObj_RETURN;
}