MqContextC_Env_TCL_API

MqContextC - protect and restore the service-environment … More...

Collaboration diagram for MqContextC_Env_TCL_API:

Functions
static OT_ProcRet	tclmqmsgque_MqContextC_EnvProtect (MqContextC_ARGS)
	Tcl: $ctx EnvProtect → C-API protect the service-environment
static OT_ProcRet	tclmqmsgque_MqContextC_EnvRestore (MqContextC_ARGS)
	Tcl: $ctx EnvRestore → C-API restore the service-environment

Detailed Description

MqContextC - protect and restore the service-environment …

The "Env" style functions are used to secure the service-environment (defined in MqEnvS)
and is required.. under special conditions... to proper answer the original service call at the
end of the service-processing.
By default tclmqmsgque guarantee the proper management of the environment on behalf of the user.
Under normal conditions the user don't need these functions.

The folllowing design-goals were defined:

• normal condition...
  • Every tclmqmsgque function does protect the original service-environment by default
  • esay goal to remember: come-in == come-out
• special condition...
  • After loading the read-data-package...
    • from the database (with MqStorageImport)
    • from the dump file (with MqDumpImport)
  • the service-environment must be in the same condition as when the read-data-package was saved.

The two design-goals from above are in conflict and the both functions MqEnvProtect and MqEnvRestore are used to solve this conflict.

Example from server.tcl → protect the environment and import from database

        # PROTECT the original service-call
        my EnvProtect
        # OVERWRITE the original service-call with data from the database
        $dump Import [self]
        set ret [my ReadALL]
        # RESTORE the original service-call
        my EnvRestore
        # ANSWER the original service-call
        my Send "R" "L" $ret

Function Documentation

tclmqmsgque_MqContextC_EnvProtect()

static OT_ProcRet tclmqmsgque_MqContextC_EnvProtect ( MqContextC_ARGS )

static

Tcl: $ctx EnvProtect → C-API
protect the service-environment

Definition at line 1394 of file MqContextC_tcl.c.

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

tclmqmsgque_MqContextC_EnvRestore()

static OT_ProcRet tclmqmsgque_MqContextC_EnvRestore ( MqContextC_ARGS )

static

Tcl: $ctx EnvRestore → C-API
restore the service-environment

Definition at line 1408 of file MqContextC_tcl.c.

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