MqMsgque_Init_C_API

MqMsgque PACKAGE - initialize the MqContextC startup and/or external-object-link … More...

Collaboration diagram for MqMsgque_Init_C_API:

Functions
MK_BFL	MqInitResetArg0 (void)
	Reset the process-startup-prefix argument to an empty list …
void	MqInitSetArg0 (MK_BAC bfl)
	set the process startup-prefix argument to bfl
void	MqInitSetArg0VA (MK_STRN arg0,...)
	set the process startup-prefix to a args
void	MqInitSetArg0VAL (MK_STRN arg0, va_list var_list)
	set the process startup-prefix to var_list
MK_BFL	MqInitGetArg0 (void)
	get the process startup-prefix argument

Variables
struct MkBufferListS *	MqInitArg0
	the process-startup-prefix argument …

MqMsgque - MqMsgque_Init_C_API - overload
#define	MqInitSetArg0_0()

Detailed Description

MqMsgque PACKAGE - initialize the MqContextC startup and/or external-object-link …

Macro Definition Documentation

MqInitSetArg0_0

#define MqInitSetArg0_0

(

)

Value:

MqInitSetArg0(NULL)

Definition at line 1113 of file msgque_overload_mq.h.

Function Documentation

MqInitGetArg0()

MK_BFL MqInitGetArg0

(

void

)

get the process startup-prefix argument

Returns

a pointer to the initialization buffer (Only C-API)

Attention

if not set return a MK_NULL pointer

MqInitResetArg0()

MK_BFL MqInitResetArg0

(

void

)

Reset the process-startup-prefix argument to an empty list …

The startup-prefix have to be the name of the executable, found in the PATH environment variable, and additional arguments like the script name or the required startup options. The startup-prefix is used for two different purpose:

• To start a new entity using the MqStartAs "--spawn" command-line option.
• To replace the command-line-argument "... @ SELF ..." with "... @ startup-prefix ..." at LinkCreate.

Every use of this function will free the data of the previous startup-prefix. By default the startup-prefix is set during application startup by libmqmsgque and have not to be initialized again.

Example from server.c → initialize the startup-prefix with the data read from service-args

static enum MkErrorE
Ot_INIT ( MQ_SERVICE_CALL_ARGS )
{
  MqInitSetArg0 (MqReadALL_e (mqctx));
error:
  return MqSendRETURN (mqctx);
}

See also

MqInitSetArg0 MqInitGetArg0

MqInitSetArg0()

void MqInitSetArg0

(

MK_BAC

bfl

)

set the process startup-prefix argument to bfl

The startup-prefix is the argument(s) required to start the application… this is minimal the binary-path for binaries (same as as used on command-line) or the interpreter+scriptFile for scripts.

Parameters

[in]

bfl

the object will be merged into the startup-prefix, afterwords the bfl is empty and can be deleted

Example

Initialize the application startup command in C

MqInitSetArg0(MkBufferListCreateV("myExec", "myExecArgument_1")); 

MqInitSetArg0VA()

void MqInitSetArg0VA	(	MK_STRN	arg0,
			... )

set the process startup-prefix to a args

Attention

… the C-Api requires a MK_NULL item on end to signal… end-of-list

MqInitSetArg0VAL()

void MqInitSetArg0VAL	(	MK_STRN	arg0,
		va_list	var_list )

set the process startup-prefix to var_list

Variable Documentation

MqInitArg0

struct MkBufferListS* MqInitArg0

extern

the process-startup-prefix argument …