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

#include <LibMqMsgque_mq.h>

Collaboration diagram for libmqmsgque::MqCtxTypeS:

Public Attributes
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 libmqmsgque::MqContextS::obj->self reference counting

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

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

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

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

MqExitF	MqProcessExitCB
	exit/cleanup a process

MqExitF	MqThreadExitCB
	exit/cleanup a thread

MqWaitForPipeF	MqWaitForPipeCB
	wait for pipe target to finish

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 ccmqmsgque

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

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 3719 of file LibMqMsgque_mq.h.

Member Data Documentation

◆ argvFix

bool libmqmsgque::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 3738 of file LibMqMsgque_mq.h.

◆ callbackMF

MkMarkF libmqmsgque::MqCtxTypeS::callbackMF

Mark the callback-data-pointer.

Definition at line 3805 of file LibMqMsgque_mq.h.

◆ Child

struct MqLinkSetupS libmqmsgque::MqCtxTypeS::Child

setup/cleanup a CHILD object

Attention

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

Definition at line 3781 of file LibMqMsgque_mq.h.

◆ dataMF

MkMarkF libmqmsgque::MqCtxTypeS::dataMF

Mark the data-pointer.

Definition at line 3802 of file LibMqMsgque_mq.h.

◆ fChildAfterFork

MqSetupF libmqmsgque::MqCtxTypeS::fChildAfterFork

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

Definition at line 3766 of file LibMqMsgque_mq.h.

◆ fDecrSelf

MqRefCountF libmqmsgque::MqCtxTypeS::fDecrSelf

decrement the libmqmsgque::MqContextS::obj->self reference counting

"Embedding" ccmqmsgque into an other language create TWO views on the same ctx … an other-language-view and an c-api-view. The libmqmsgque::MqContextS::obj->self is the connection c-api -> other-lng and the other-lng has something equal. Usually the other-lng using libmqmsgque::MqContextS->MkObjectS::refCount++ and libmqmsgque::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 libmqmsgque::MqContextS::obj->self have to be protected*… this protection is done with *other-lng-refCount-protection

Definition at line 3757 of file LibMqMsgque_mq.h.

◆ fHelp

MqHelpF libmqmsgque::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 ccmqmsgque startup code in MqLinkCreate checks for the both options -h and --help to provide a tool-specific help-page and exit.

Definition at line 3815 of file LibMqMsgque_mq.h.

◆ fIncrSelf

MqRefCountF libmqmsgque::MqCtxTypeS::fIncrSelf

increment the libmqmsgque::MqContextS::obj->self reference counting

"Embedding" ccmqmsgque into an other language create TWO views on the same ctx … an other-language-view and an c-api-view. The libmqmsgque::MqContextS::obj->self is the connection c-api -> other-lng and the other-lng has something equal. Usually the other-lng using libmqmsgque::MqContextS->MkObjectS::refCount++ and libmqmsgque::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 libmqmsgque::MqContextS::obj->self have to be protected*… this protection is done with *other-lng-refCount-protection

Definition at line 3752 of file LibMqMsgque_mq.h.

◆ fParentAfterFork

MqSetupF libmqmsgque::MqCtxTypeS::fParentAfterFork

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

Definition at line 3763 of file LibMqMsgque_mq.h.

◆ fParentBeforeFork

MqSetupF libmqmsgque::MqCtxTypeS::fParentBeforeFork

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

Definition at line 3760 of file LibMqMsgque_mq.h.

◆ fSpawnInit

MqSetupF libmqmsgque::MqCtxTypeS::fSpawnInit

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

Definition at line 3821 of file LibMqMsgque_mq.h.

◆ fThreadInit

MqSetupF libmqmsgque::MqCtxTypeS::fThreadInit

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

Definition at line 3818 of file LibMqMsgque_mq.h.

◆ Idle

struct MqCallbackS libmqmsgque::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 libmqmsgque::MqCallbackS::data will not be freed or protected against garbage collection, -> only use libmqmsgque::MqCallbackS::fCall

Definition at line 3799 of file LibMqMsgque_mq.h.

◆ ignoreDisasterSetup

bool libmqmsgque::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 3830 of file LibMqMsgque_mq.h.

◆ ignoreFork

bool libmqmsgque::MqCtxTypeS::ignoreFork

do not allow the usage of fork

Definition at line 3747 of file LibMqMsgque_mq.h.

◆ ignoreSpawn

bool libmqmsgque::MqCtxTypeS::ignoreSpawn

do not allow the usage of spawn

Definition at line 3744 of file LibMqMsgque_mq.h.

◆ ignoreThread

bool libmqmsgque::MqCtxTypeS::ignoreThread

do not allow the usage of threads

Definition at line 3741 of file LibMqMsgque_mq.h.

◆ MqProcessExitCB

MqExitF libmqmsgque::MqCtxTypeS::MqProcessExitCB

exit/cleanup a process

Definition at line 3769 of file LibMqMsgque_mq.h.

◆ MqThreadExitCB

MqExitF libmqmsgque::MqCtxTypeS::MqThreadExitCB

exit/cleanup a thread

Definition at line 3772 of file LibMqMsgque_mq.h.

◆ MqWaitForPipeCB

MqWaitForPipeF libmqmsgque::MqCtxTypeS::MqWaitForPipeCB

wait for pipe target to finish

Definition at line 3775 of file LibMqMsgque_mq.h.

◆ obj

struct MkObjectS libmqmsgque::MqCtxTypeS::obj

Definition at line 3723 of file LibMqMsgque_mq.h.

◆ Parent

struct MqLinkSetupS libmqmsgque::MqCtxTypeS::Parent

setup/cleanup a PARENT object

Attention: always call this functions using MqLinkCreate and MqLinkDelete

Definition at line 3785 of file LibMqMsgque_mq.h.

◆ [union]

union { ... } libmqmsgque::MqCtxTypeS::super

◆ typ

struct MkTypeS libmqmsgque::MqCtxTypeS::typ

Definition at line 3724 of file LibMqMsgque_mq.h.

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

LibMqMsgque_mq.h

Public Attributes