MqContextC_ATL_API

MqContextC - the class known as ctx or context is the application-handle of the application-server and also the main data-handle … More...

Collaboration diagram for MqContextC_ATL_API:

Topics
	MqContextC_Class_ATL_API
	MqContextC - define the class …
	MqContextC_TOR_ATL_API
	MqContextC - various functions to create, initialize and destroy a context …
	MqContextC_ClassApi_ATL_API
	MqContextC - access data related to the factory-type of the object …
	MqContextC_ConfigApi_ATL_API
	MqContextC - various functions to config a context …
	MqContextC_Link_ATL_API
	MqContextC - setup and manage a client-server-link …
	MqContextC_SlaveApi_ATL_API
	MqContextC - create and manage a slave context …
	MqContextC_SendApi_ATL_API
	MqContextC - construct an outgoing send-data-package …
	MqContextC_ReadApi_ATL_API
	MqContextC - extract data from an incoming read-data-package …
	MqContextC_Proxy_ATL_API
	MqContextC - copy data from the read-data-package of the sourceCtx to the send-data-package of the targetCtx
	MqContextC_Route_ATL_API
	MqContextC - setup and manage a routing-link …
	MqContextC_Service_ATL_API
	MqContextC - create and manage a service …
	MqContextC_StorageApi_ATL_API
	MqContextC - setup and manage a storage used to persist data-packages …
	MqContextC_High_ATL_API
	MqContextC - User friendly replacement for the MqContextC_SendApi_C_API and the MqContextC_ReadApi_C_API …
	MqContextC_Env_ATL_API
	MqContextC - protect and restore the service-environment …
	MqContextC_Error_ATL_API
	MqContextC - move and copy an error from a context …
	MqContextC_Log_ATL_API
	MqContextC - log the output to a string or a MkLogFileC …
	MqContextC_Filter_ATL_API
	MqContextC - modify the data using the filter-technology …
	MqContextC_Misc_ATL_API
	MqContextC - various functions to work on a context …

Functions
static OT_ProcRet	atlmqmsgque_MqContextC_Debug (MqContextC_ARGS)
	TCL: $ctx Debug prefix:string
static OT_ProcRet	atlmqmsgque_MqContextC_printObj (MqContextC_ARGS)
	TCL: $ctx printObj obj:Tcl_Obj ?prefix:string=""?

Detailed Description

MqContextC - the class known as ctx or context is the application-handle of the application-server and also the main data-handle …

The context is the package-item with the required features and created by the implementation-layer-programmer. The context can be a client or a server.

HOWTO client-context

The client-context-creation is triggerd by the software-workflow on demand. The client is calling the MqLinkCreate to create a connection to the server using the connection-arguments to specify the target.

The life-cycle of a client is:

ContextCreate	create and initialize the MqContextC ...
LinkCreate	make ctx to a parent-context and setup a new client-server-link …
SendTT	MqContextC - append a native PRIMITIVE TYPE value to the send-data-package …
ReadTT	read a PRIMITIVE TYPE from the read-data-package …
LinkDelete	close the client-server-link …
ContextDelete	Destructor - delete a MqContextC instance …
Exit	delete the context and exit the current process or thread …

HOWTO server-context

The server-context-creation is always triggerd by the MqLinkCreate command of the client. The server is usually using a factory-constructor to call the MqContextCreate and finally to call the MqContextDelete.
The server-context is fully under control of the client.

The life-cycle of a server is:

SETUP	define a class and add the setup/cleanup code
MqServerSetupIF	define the server-setup-interface (callback) used on startup …
ServiceCreate	create a link between a service-token and a service-callback …
MqServerCleanupIF	define the server-cleanup-interface (callback) used on cleanup …
ServiceDelete	delete a service. …
STARTUP	define the factory and start the listener
FactoryAdd	Add a new MqFactoryC identified by factory-identifier and defined by factory-constructor …
FactoryNew	create a new MqContextC from a MqFactoryC …
LinkCreate	make ctx to a parent-context and setup a new client-server-link …
ProcessEvent	enter the event-loop and wait for an incoming service-request. …
WORK	process the service-calls and exit on end
ReadTT	read a PRIMITIVE TYPE from the read-data-package …
SendTT	MqContextC - append a native PRIMITIVE TYPE value to the send-data-package …
Exit	delete the context and exit the current process or thread …

MqContextC CTOR and DTOR

command	alias
(constructor,static) MqContextC [MqContextC::Create ?tmpl:MqContextC=NULL?]	myooX::NewN ::MqContextC ?tmpl:MqContextC=""?
(destructor) MqContextC::Delete $ctx	myooX::DeleteN $ctx

Function Documentation

atlmqmsgque_MqContextC_Debug()

static OT_ProcRet atlmqmsgque_MqContextC_Debug ( MqContextC_ARGS )

static

TCL: $ctx Debug prefix:string

Definition at line 366 of file MqContextC_atl.c.

{
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(1,1,"$ctx Debug prefix:str");
  MK_STRN prefix;
  OT_CHECK_STR(prefix)
  OT_CHECK_NOARGS
  MkLogC_4X(hdl,"…\n",0,prefix),
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

atlmqmsgque_MqContextC_printObj()

static OT_ProcRet atlmqmsgque_MqContextC_printObj ( MqContextC_ARGS )

static

TCL: $ctx printObj obj:Tcl_Obj ?prefix:string=""?

Definition at line 384 of file MqContextC_atl.c.

{
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(1,2,"$ctx printObj obj:Tcl_Obj ?prefix:string=\"\"?");
  OT_OBJ_T tclO = 0;;
  OT_CHECK_REQUIRED(OT_CHECK_LNG_T(tclO));
  MK_STRN prefix="print";
  OT_CHECK_OPTIONAL(OT_CHECK_STR(prefix));
  OT_CHECK_NOARGS;
  MK_OBJ  obj;
  MkTestClassE  flag;
  int     mqR;
  if(OT_LNG_OBJECT_IS_3(tclO, &obj, &flag)) {
    mqR=-2;
    switch (flag) {
      case MkTestClassE_OK:                   mqR=obj->refCount;  break;
      case MkTestClassE_NULL:                 mqR=0;              break;
      case MkTestClassE_INVALID_SIGNATURE:    mqR=-1;             break;
      case MkTestClassE_NONE_OBJECT:
      case MkTestClassE_WRONG_CLASS:
      case MkTestClassE_INTERNAL:             mqR=-2;             break;
    }
  } else {
    mqR=-2;
  }
  printXV(hdl,"%-10s: string<%s>, type<%s>, refCount[mq=%i,tcl=%i], ptr<%p>\n",
    prefix, Tcl_GetString(tclO), MK(GetTypeFromObj) (OT_Prefix_CALL tclO, NULL), mqR, tclO->refCount, tclO
  );
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}