MqContextC_Env_CS_API

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

Collaboration diagram for MqContextC_Env_CS_API:

Functions
void	csmqmsgque.MqContextC.EnvProtect ()
	C#: ctx.EnvProtect() → C-API protect the service-environment
void	csmqmsgque.MqContextC.EnvRestore ()
	C#: 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 csmqmsgque 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 csmqmsgque 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.cs → protect the environment and import from database

          // PROTECT the original service-call
          EnvProtect();
          // OVERWRITE the original service-call with data from the database
          dump.Import(this);
          var read = ReadALL();
          // RESTORE the original service-call
          EnvRestore();
          // ANSWER the original service-call
          Send("R", "L", read);

Function Documentation

EnvProtect()

void csmqmsgque.MqContextC.EnvProtect ( )

inline

C#: ctx.EnvProtect() → C-API
protect the service-environment

Definition at line 685 of file MqContextC.cs.

                               {
      Mq.MqEnvProtect(mkrt, hdl);
    }

EnvRestore()

void csmqmsgque.MqContextC.EnvRestore ( )

inline

C#: ctx.EnvRestore() → C-API
restore the service-environment

Definition at line 690 of file MqContextC.cs.

                               {
      Mq.MqEnvRestore(hdl);
    }