MqCtxTypeS - the instance-base for the MqContextC … More...

#include <LibMqMsgque_mq.h>

Collaboration diagram for MqCtxTypeS:

Data Fields
union {

struct MkObjectS obj

struct MkTypeS typ

}	super

bool	argvFix
	add first argument in MkBufferListC argument to MqLinkCreate and MqLinkCreateChild

bool	ignoreThread
	do not allow the usage of threads

bool	ignoreSpawn
	do not allow the usage of spawn

bool	ignoreFork
	do not allow the usage of fork

MqRefCountF	fIncrSelf
	increment the MqContextS::obj->self reference counting

MqRefCountF	fDecrSelf
	decrement the MqContextS::obj->self reference counting

MqSetupF	fParentBeforeFork
	setup and initialize a fork-process before a new fork-process is created by pymqmsgque

MqSetupF	fParentAfterFork
	cleanup a parent fork-process after a new fork-process is created by pymqmsgque

MqSetupF	fChildAfterFork
	cleanup a child fork-process after a new fork-process is created by pymqmsgque

MqExitF	fProcessExit
	exit/cleanup a process

MqExitF	fThreadExit
	exit/cleanup a thread

struct MqLinkSetupS	Child
	setup/cleanup a CHILD object

struct MqLinkSetupS	Parent
	setup/cleanup a PARENT object

struct MqCallbackS	Idle
	Create a link to the calling tool idle-event-handling …

MkMarkF	dataMF
	Mark the data-pointer.

MkMarkF	callbackMF
	Mark the callback-data-pointer.

MqHelpF	fHelp
	Create a link to the calling tool help function.

MqSetupF	fThreadInit
	setup and initialize a thread before a new thread is created by pymqmsgque

MqSetupF	fSpawnInit
	setup and initialize a spawn-process before a new spawn-process is created by pymqmsgque

bool	ignoreDisasterSetup
	do not setup the disaster-handler at startup.

Detailed Description

MqCtxTypeS - the instance-base for the MqContextC …

The MqCtxTypeS is the instance-base for the MqContextC and has all attributes shared with all MqContextC instances.

Definition at line 3663 of file LibMqMsgque_mq.h.

Field Documentation

◆ argvFix

bool MqCtxTypeS::argvFix

add first argument in MkBufferListC argument to MqLinkCreate and MqLinkCreateChild

On C, the startup arguments are available as argc and argv arguments of the main procedure. The first argument (argv[0]) has the executable name. Other programming languages like TCL or CSharp does NOT provide the executable name as first argument of the main argv. If argsFix is set to true this will be fixed. Default is false.

See also: MqLinkCreate MqLinkCreateChild

Definition at line 3682 of file LibMqMsgque_mq.h.

◆ callbackMF

MkMarkF MqCtxTypeS::callbackMF

Mark the callback-data-pointer.

Definition at line 3746 of file LibMqMsgque_mq.h.

◆ Child

struct MqLinkSetupS MqCtxTypeS::Child

setup/cleanup a CHILD object

Attention

Always call this functions using MqLinkCreate and MqLinkDelete.
A child is a parent with MqConfigS::parent != NULL.

Definition at line 3722 of file LibMqMsgque_mq.h.

◆ dataMF

MkMarkF MqCtxTypeS::dataMF

Mark the data-pointer.

Definition at line 3743 of file LibMqMsgque_mq.h.

◆ fChildAfterFork

MqSetupF MqCtxTypeS::fChildAfterFork

cleanup a child fork-process after a new fork-process is created by pymqmsgque

Definition at line 3710 of file LibMqMsgque_mq.h.

◆ fDecrSelf

MqRefCountF MqCtxTypeS::fDecrSelf

decrement the MqContextS::obj->self reference counting

"Embedding" pymqmsgque into an other language create TWO views on the same ctx … an other-language-view and an c-api-view. The MqContextS::obj->self is the connection c-api -> other-lng and the other-lng has something equal. Usually the other-lng using MqContextS->MkObjectS::refCount++ and MqContextS->MkObjectS::refCount– to bind the c-api-view to the other-language-view. For the special purpose of "embedding" a slave into a master*… as example… the *slave is entirely controlled by the master and the MqContextS::obj->self have to be protected*… this protection is done with *other-lng-refCount-protection

Definition at line 3701 of file LibMqMsgque_mq.h.

◆ fHelp

MqHelpF MqCtxTypeS::fHelp

Create a link to the calling tool help function.

type	default	option	application	context
POINTER	NULL	NO	server/client	parent

As a service to the programmer the pymqmsgque startup code in MqLinkCreate checks for the both options -h and --help to provide a tool-specific help-page and exit.

Definition at line 3756 of file LibMqMsgque_mq.h.

◆ fIncrSelf

MqRefCountF MqCtxTypeS::fIncrSelf

increment the MqContextS::obj->self reference counting

"Embedding" pymqmsgque into an other language create TWO views on the same ctx … an other-language-view and an c-api-view. The MqContextS::obj->self is the connection c-api -> other-lng and the other-lng has something equal. Usually the other-lng using MqContextS->MkObjectS::refCount++ and MqContextS->MkObjectS::refCount– to bind the c-api-view to the other-language-view. For the special purpose of "embedding" a slave into a master*… as example… the *slave is entirely controlled by the master and the MqContextS::obj->self have to be protected*… this protection is done with *other-lng-refCount-protection

Definition at line 3696 of file LibMqMsgque_mq.h.

◆ fParentAfterFork

MqSetupF MqCtxTypeS::fParentAfterFork

cleanup a parent fork-process after a new fork-process is created by pymqmsgque

Definition at line 3707 of file LibMqMsgque_mq.h.

◆ fParentBeforeFork

MqSetupF MqCtxTypeS::fParentBeforeFork

setup and initialize a fork-process before a new fork-process is created by pymqmsgque

Definition at line 3704 of file LibMqMsgque_mq.h.

◆ fProcessExit

MqExitF MqCtxTypeS::fProcessExit

exit/cleanup a process

Definition at line 3713 of file LibMqMsgque_mq.h.

◆ fSpawnInit

MqSetupF MqCtxTypeS::fSpawnInit

setup and initialize a spawn-process before a new spawn-process is created by pymqmsgque

Definition at line 3762 of file LibMqMsgque_mq.h.

◆ fThreadExit

MqExitF MqCtxTypeS::fThreadExit

exit/cleanup a thread

Definition at line 3716 of file LibMqMsgque_mq.h.

◆ fThreadInit

MqSetupF MqCtxTypeS::fThreadInit

setup and initialize a thread before a new thread is created by pymqmsgque

Definition at line 3759 of file LibMqMsgque_mq.h.

◆ Idle

struct MqCallbackS MqCtxTypeS::Idle

Create a link to the calling tool idle-event-handling …

The Idle-Function is used to process tasks in the background to give the tool-user the feeling of a non-blocking application. For example Tcl using the event-handling to update the Tk user-interface while the application is waiting for data. The Idle-Function is called on idle-time and is designed for a very short function execution time. Do only one action per function call. This function will be called with a ~10000 usec interval to guarantee a parallel like execution.

Attention: The MqCallbackS::data will not be freed or protected against garbage collection, -> only use MqCallbackS::fCall

Definition at line 3740 of file LibMqMsgque_mq.h.

◆ ignoreDisasterSetup

bool MqCtxTypeS::ignoreDisasterSetup

do not setup the disaster-handler at startup.

The disaster-handler bind the function MkDisasterSignal to the signal SIGSEGV and is used to print the stack-trace and additional MqContextC data to MkRuntimeS::logFILE on crash.

The problem is, if a target-application (language) needs SIGSEGV, this function can be deactivated with ignoreDisasterSetup = true.

Definition at line 3771 of file LibMqMsgque_mq.h.

◆ ignoreFork

bool MqCtxTypeS::ignoreFork

do not allow the usage of fork

Definition at line 3691 of file LibMqMsgque_mq.h.

◆ ignoreSpawn

bool MqCtxTypeS::ignoreSpawn

do not allow the usage of spawn

Definition at line 3688 of file LibMqMsgque_mq.h.

◆ ignoreThread

bool MqCtxTypeS::ignoreThread

do not allow the usage of threads

Definition at line 3685 of file LibMqMsgque_mq.h.

◆ obj

struct MkObjectS MqCtxTypeS::obj

Definition at line 3667 of file LibMqMsgque_mq.h.

◆ Parent

struct MqLinkSetupS MqCtxTypeS::Parent

setup/cleanup a PARENT object

Attention: always call this functions using MqLinkCreate and MqLinkDelete

Definition at line 3726 of file LibMqMsgque_mq.h.

◆ [union]

union { ... } MqCtxTypeS::super

◆ typ

struct MkTypeS MqCtxTypeS::typ

Definition at line 3668 of file LibMqMsgque_mq.h.

The documentation for this struct was generated from the following file:

LibMqMsgque_mq.h

Data Fields