MqContextC - various function to 'set' the configuration-data in a context … More...

Collaboration diagram for MqContextC_ConfigApi_Set_C_API:

Functions
MQ_EXTERN void	MqConfigSetName_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_STRN data)
	set the MqConfigS::dispname value and cleanup old value

MQ_EXTERN void	MqConfigSetPrefixWithNoLock_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_STRN data)
	set the MqConfigS::prefix with low-priority …

MQ_EXTERN void	MqConfigSetPrefix_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_STRN data)
	set the server-part (1) of the application-identifer MqConfigS::dispname …

MQ_EXTERN void	MqConfigSetPostfix_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_STRN data)
	set the client-part (2) of the application-identifer MqConfigS::dispname …

MQ_EXTERN void	MqConfigSetStorage_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_STRN data)
	set the Storage value and cleanup old value

MQ_EXTERN void	MqConfigSetAllTimeout (MQ_CTX const ctx, MK_TIME_T data) MK_ATTR_HDL
	set the MqIoConfigS::timeout value

MQ_EXTERN enum MkErrorE	MqConfigSetAllDebug_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_I32 const data)
	set the MkRuntimeS::debug value

MQ_EXTERN void	MqConfigSetIsString (MQ_CTX const ctx, bool data) MK_ATTR_HDL
	set the MqConfigS::native value 'S'string or 'L'owEndian or 'B'igEndian

MQ_EXTERN enum MkErrorE	MqConfigSetStartAs (MQ_CTX const ctx, enum MqStartE data) MK_ATTR_HDL
	set the MqConfigS::startAs value

MQ_EXTERN enum MkErrorE	MqConfigSetStartAsString (MQ_CTX const ctx, MK_STRN data) MK_ATTR_HDL
	set the MqConfigS::startAs value using string `default`, `thread`, `fork` or `spawn`

MQ_EXTERN bool	MqConfigCheckStartAs (MQ_CTX const ctx, enum MqStartE data) MK_ATTR_HDL
	check if MqConfigS::startAs can be set to data

MQ_EXTERN enum MkErrorE	MqConfigSetIoUds_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_STRN file)
	configure a context to use a uds-client-server-link …

MQ_EXTERN enum MkErrorE	MqConfigSetIoTcp_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_STRN host, MK_STRN port, MK_STRN myhost, MK_STRN myport)
	configure a context to use a tcp-client-server-link …

MQ_EXTERN enum MkErrorE	MqConfigSetIoTcpL_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_BFL const vals)
	configure a context to use a tcp-client-server-link …

MQ_EXTERN enum MkErrorE	MqConfigSetIoPipe_RT (MK_RT const mkrt, MQ_CTX const ctx, MQ_SOCK_HDL fh)
	set the pipe configuration data …

MQ_EXTERN enum MkErrorE	MqConfigSetDaemon_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_STRN pidfile)
	start the server-context as daemon …

MQ_EXTERN void	MqConfigSetBuffersize (MQ_CTX const ctx, MK_I32 data) MK_ATTR_HDL
	set the MqIoConfigS::buffersize value

MQ_EXTERN void	MqConfigSetPkgsize (MQ_CTX const ctx, MK_I32 data) MK_ATTR_HDL
	set the MqIoConfigS::pkgsize value

MQ_EXTERN void	MqConfigSetTimeout (MQ_CTX const ctx, MK_TIME_T data) MK_ATTR_HDL
	set the MqIoConfigS::timeout value

MQ_EXTERN void	MqConfigSetIsServer (MQ_CTX const ctx, bool data) MK_ATTR_HDL
	set the MqSetupS::isServer value

MQ_EXTERN void	MqConfigSetIdentFrom (MQ_CTX const ctx, enum MqIdentE data) MK_ATTR_HDL
	set the MqConfigS::identFrom value

MQ_EXTERN void	MqConfigSetIgnoreExit (MQ_CTX const ctx, bool data) MK_ATTR_HDL
	set the MqSetupS::ignoreExit value

MqContextC - MqContextC_ConfigApi_Set_C_API - overload
#define	MqConfigSetAllDebug_NULL(...)

#define	MqConfigSetAllDebug(...)

#define	MqConfigSetAllDebug_E(...)

#define	MqConfigSetAllDebug_C(...)

#define	MqConfigSetDaemon_NULL(...)

#define	MqConfigSetDaemon(...)

#define	MqConfigSetDaemon_E(...)

#define	MqConfigSetDaemon_C(...)

#define	MqConfigSetIoPipe_NULL(...)

#define	MqConfigSetIoPipe(...)

#define	MqConfigSetIoPipe_E(...)

#define	MqConfigSetIoPipe_C(...)

#define	MqConfigSetIoTcp_NULL(...)

#define	MqConfigSetIoTcp(...)

#define	MqConfigSetIoTcp_4(ctx, host, port, myhost)

#define	MqConfigSetIoTcp_3(ctx, host, port)

#define	MqConfigSetIoTcp_2(ctx, host)

#define	MqConfigSetIoTcp_1(ctx)

#define	MqConfigSetIoTcp_E(...)

#define	MqConfigSetIoTcp_C(...)

#define	MqConfigSetIoTcpL_NULL(...)

#define	MqConfigSetIoTcpL(...)

#define	MqConfigSetIoTcpL_E(...)

#define	MqConfigSetIoTcpL_C(...)

#define	MqConfigSetIoUds_NULL(...)

#define	MqConfigSetIoUds(...)

#define	MqConfigSetIoUds_E(...)

#define	MqConfigSetIoUds_C(...)

#define	MqConfigSetName_NULL(...)

#define	MqConfigSetName(...)

#define	MqConfigSetPostfix_NULL(...)

#define	MqConfigSetPostfix(...)

#define	MqConfigSetPrefix_NULL(...)

#define	MqConfigSetPrefix(...)

#define	MqConfigSetPrefixWithNoLock_NULL(...)

#define	MqConfigSetPrefixWithNoLock(...)

#define	MqConfigSetStartAs_E(...)

#define	MqConfigSetStartAs_C(...)

#define	MqConfigSetStartAsString_E(...)

#define	MqConfigSetStartAsString_C(...)

#define	MqConfigSetStorage_NULL(...)

#define	MqConfigSetStorage(...)

Detailed Description

MqContextC - various function to 'set' the configuration-data in a context …

Macro Definition Documentation

◆ MqConfigSetAllDebug

#define MqConfigSetAllDebug ( ... )

Value:

MqConfigSetAllDebug_RT(MK_RT_CALL __VA_ARGS__)

MK_RT_CALL

#define MK_RT_CALL

MqConfigSetAllDebug_RT

MQ_EXTERN enum MkErrorE MqConfigSetAllDebug_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_I32 const data)

set the MkRuntimeS::debug value

Definition at line 120 of file msgque_overload_mq.h.

◆ MqConfigSetAllDebug_C

#define MqConfigSetAllDebug_C ( ... )

Value:

if (MkErrorCheckI(MqConfigSetAllDebug(__VA_ARGS__)))

MqConfigSetAllDebug

#define MqConfigSetAllDebug(...)

Definition msgque_overload_mq.h:120

Definition at line 122 of file msgque_overload_mq.h.

◆ MqConfigSetAllDebug_E

#define MqConfigSetAllDebug_E ( ... )

Value:

MkErrorCheck(MqConfigSetAllDebug(__VA_ARGS__))

Definition at line 121 of file msgque_overload_mq.h.

◆ MqConfigSetAllDebug_NULL

#define MqConfigSetAllDebug_NULL ( ... )

Value:

MqConfigSetAllDebug_RT(MK_RT_CALL_NULL __VA_ARGS__)

MK_RT_CALL_NULL

#define MK_RT_CALL_NULL

Definition at line 119 of file msgque_overload_mq.h.

◆ MqConfigSetDaemon

#define MqConfigSetDaemon ( ... )

Value:

MqConfigSetDaemon_RT(MK_RT_CALL __VA_ARGS__)

MqConfigSetDaemon_RT

MQ_EXTERN enum MkErrorE MqConfigSetDaemon_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_STRN pidfile)

start the server-context as daemon …

Definition at line 124 of file msgque_overload_mq.h.

◆ MqConfigSetDaemon_C

#define MqConfigSetDaemon_C ( ... )

Value:

if (MkErrorCheckI(MqConfigSetDaemon(__VA_ARGS__)))

MqConfigSetDaemon

#define MqConfigSetDaemon(...)

Definition msgque_overload_mq.h:124

Definition at line 126 of file msgque_overload_mq.h.

◆ MqConfigSetDaemon_E

#define MqConfigSetDaemon_E ( ... )

Value:

MkErrorCheck(MqConfigSetDaemon(__VA_ARGS__))

Definition at line 125 of file msgque_overload_mq.h.

◆ MqConfigSetDaemon_NULL

#define MqConfigSetDaemon_NULL ( ... )

Value:

MqConfigSetDaemon_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 123 of file msgque_overload_mq.h.

◆ MqConfigSetIoPipe

#define MqConfigSetIoPipe ( ... )

Value:

MqConfigSetIoPipe_RT(MK_RT_CALL __VA_ARGS__)

MqConfigSetIoPipe_RT

MQ_EXTERN enum MkErrorE MqConfigSetIoPipe_RT(MK_RT const mkrt, MQ_CTX const ctx, MQ_SOCK_HDL fh)

set the pipe configuration data …

Definition at line 128 of file msgque_overload_mq.h.

◆ MqConfigSetIoPipe_C

#define MqConfigSetIoPipe_C ( ... )

Value:

if (MkErrorCheckI(MqConfigSetIoPipe(__VA_ARGS__)))

MqConfigSetIoPipe

#define MqConfigSetIoPipe(...)

Definition msgque_overload_mq.h:128

Definition at line 130 of file msgque_overload_mq.h.

◆ MqConfigSetIoPipe_E

#define MqConfigSetIoPipe_E ( ... )

Value:

MkErrorCheck(MqConfigSetIoPipe(__VA_ARGS__))

Definition at line 129 of file msgque_overload_mq.h.

◆ MqConfigSetIoPipe_NULL

#define MqConfigSetIoPipe_NULL ( ... )

Value:

MqConfigSetIoPipe_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 127 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcp

#define MqConfigSetIoTcp ( ... )

Value:

MqConfigSetIoTcp_RT(MK_RT_CALL __VA_ARGS__)

MqConfigSetIoTcp_RT

MQ_EXTERN enum MkErrorE MqConfigSetIoTcp_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_STRN host, MK_STRN port, MK_STRN myhost, MK_STRN myport)

configure a context to use a tcp-client-server-link …

Definition at line 132 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcp_1

#define MqConfigSetIoTcp_1 ( ctx )

Value:

MqConfigSetIoTcp(ctx,NULL,NULL,NULL,NULL)

MqConfigSetIoTcp

#define MqConfigSetIoTcp(...)

Definition msgque_overload_mq.h:132

Definition at line 136 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcp_2

#define MqConfigSetIoTcp_2	(		ctx,
			host )

Value:

MqConfigSetIoTcp(ctx,host,NULL,NULL,NULL)

Definition at line 135 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcp_3

#define MqConfigSetIoTcp_3	(	ctx,
		host,
		port )

Value:

MqConfigSetIoTcp(ctx,host,port,NULL,NULL)

Definition at line 134 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcp_4

#define MqConfigSetIoTcp_4	(	ctx,
		host,
		port,
		myhost )

Value:

MqConfigSetIoTcp(ctx,host,port,myhost,NULL)

Definition at line 133 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcp_C

#define MqConfigSetIoTcp_C ( ... )

Value:

if (MkErrorCheckI(MqConfigSetIoTcp(__VA_ARGS__)))

Definition at line 138 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcp_E

#define MqConfigSetIoTcp_E ( ... )

Value:

MkErrorCheck(MqConfigSetIoTcp(__VA_ARGS__))

Definition at line 137 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcp_NULL

#define MqConfigSetIoTcp_NULL ( ... )

Value:

MqConfigSetIoTcp_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 131 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcpL

#define MqConfigSetIoTcpL ( ... )

Value:

MqConfigSetIoTcpL_RT(MK_RT_CALL __VA_ARGS__)

MqConfigSetIoTcpL_RT

MQ_EXTERN enum MkErrorE MqConfigSetIoTcpL_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_BFL const vals)

configure a context to use a tcp-client-server-link …

Definition at line 140 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcpL_C

#define MqConfigSetIoTcpL_C ( ... )

Value:

if (MkErrorCheckI(MqConfigSetIoTcpL(__VA_ARGS__)))

MqConfigSetIoTcpL

#define MqConfigSetIoTcpL(...)

Definition msgque_overload_mq.h:140

Definition at line 142 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcpL_E

#define MqConfigSetIoTcpL_E ( ... )

Value:

MkErrorCheck(MqConfigSetIoTcpL(__VA_ARGS__))

Definition at line 141 of file msgque_overload_mq.h.

◆ MqConfigSetIoTcpL_NULL

#define MqConfigSetIoTcpL_NULL ( ... )

Value:

MqConfigSetIoTcpL_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 139 of file msgque_overload_mq.h.

◆ MqConfigSetIoUds

#define MqConfigSetIoUds ( ... )

Value:

MqConfigSetIoUds_RT(MK_RT_CALL __VA_ARGS__)

MqConfigSetIoUds_RT

MQ_EXTERN enum MkErrorE MqConfigSetIoUds_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_STRN file)

configure a context to use a uds-client-server-link …

Definition at line 144 of file msgque_overload_mq.h.

◆ MqConfigSetIoUds_C

#define MqConfigSetIoUds_C ( ... )

Value:

if (MkErrorCheckI(MqConfigSetIoUds(__VA_ARGS__)))

MqConfigSetIoUds

#define MqConfigSetIoUds(...)

Definition msgque_overload_mq.h:144

Definition at line 146 of file msgque_overload_mq.h.

◆ MqConfigSetIoUds_E

#define MqConfigSetIoUds_E ( ... )

Value:

MkErrorCheck(MqConfigSetIoUds(__VA_ARGS__))

Definition at line 145 of file msgque_overload_mq.h.

◆ MqConfigSetIoUds_NULL

#define MqConfigSetIoUds_NULL ( ... )

Value:

MqConfigSetIoUds_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 143 of file msgque_overload_mq.h.

◆ MqConfigSetName

#define MqConfigSetName ( ... )

Value:

MqConfigSetName_RT(MK_RT_CALL __VA_ARGS__)

MqConfigSetName_RT

MQ_EXTERN void MqConfigSetName_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_STRN data)

set the MqConfigS::dispname value and cleanup old value

Definition at line 148 of file msgque_overload_mq.h.

◆ MqConfigSetName_NULL

#define MqConfigSetName_NULL ( ... )

Value:

MqConfigSetName_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 147 of file msgque_overload_mq.h.

◆ MqConfigSetPostfix

#define MqConfigSetPostfix ( ... )

Value:

MqConfigSetPostfix_RT(MK_RT_CALL __VA_ARGS__)

MqConfigSetPostfix_RT

MQ_EXTERN void MqConfigSetPostfix_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_STRN data)

set the client-part (2) of the application-identifer MqConfigS::dispname …

Definition at line 150 of file msgque_overload_mq.h.

◆ MqConfigSetPostfix_NULL

#define MqConfigSetPostfix_NULL ( ... )

Value:

MqConfigSetPostfix_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 149 of file msgque_overload_mq.h.

◆ MqConfigSetPrefix

#define MqConfigSetPrefix ( ... )

Value:

MqConfigSetPrefix_RT(MK_RT_CALL __VA_ARGS__)

MqConfigSetPrefix_RT

MQ_EXTERN void MqConfigSetPrefix_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_STRN data)

set the server-part (1) of the application-identifer MqConfigS::dispname …

Definition at line 152 of file msgque_overload_mq.h.

◆ MqConfigSetPrefix_NULL

#define MqConfigSetPrefix_NULL ( ... )

Value:

MqConfigSetPrefix_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 151 of file msgque_overload_mq.h.

◆ MqConfigSetPrefixWithNoLock

#define MqConfigSetPrefixWithNoLock ( ... )

Value:

MqConfigSetPrefixWithNoLock_RT(MK_RT_CALL __VA_ARGS__)

MqConfigSetPrefixWithNoLock_RT

MQ_EXTERN void MqConfigSetPrefixWithNoLock_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_STRN data)

set the MqConfigS::prefix with low-priority …

Definition at line 154 of file msgque_overload_mq.h.

◆ MqConfigSetPrefixWithNoLock_NULL

#define MqConfigSetPrefixWithNoLock_NULL ( ... )

Value:

MqConfigSetPrefixWithNoLock_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 153 of file msgque_overload_mq.h.

◆ MqConfigSetStartAs_C

#define MqConfigSetStartAs_C ( ... )

Value:

if (MkErrorCheckI(MqConfigSetStartAs(__VA_ARGS__)))

MqConfigSetStartAs

MQ_EXTERN enum MkErrorE MqConfigSetStartAs(MQ_CTX const ctx, enum MqStartE data) MK_ATTR_HDL

set the MqConfigS::startAs value

Definition at line 156 of file msgque_overload_mq.h.

◆ MqConfigSetStartAs_E

#define MqConfigSetStartAs_E ( ... )

Value:

MkErrorCheck(MqConfigSetStartAs(__VA_ARGS__))

Definition at line 155 of file msgque_overload_mq.h.

◆ MqConfigSetStartAsString_C

#define MqConfigSetStartAsString_C ( ... )

Value:

if (MkErrorCheckI(MqConfigSetStartAsString(__VA_ARGS__)))

MqConfigSetStartAsString

MQ_EXTERN enum MkErrorE MqConfigSetStartAsString(MQ_CTX const ctx, MK_STRN data) MK_ATTR_HDL

set the MqConfigS::startAs value using string default, thread, fork or spawn

Definition at line 158 of file msgque_overload_mq.h.

◆ MqConfigSetStartAsString_E

#define MqConfigSetStartAsString_E ( ... )

Value:

MkErrorCheck(MqConfigSetStartAsString(__VA_ARGS__))

Definition at line 157 of file msgque_overload_mq.h.

◆ MqConfigSetStorage

#define MqConfigSetStorage ( ... )

Value:

MqConfigSetStorage_RT(MK_RT_CALL __VA_ARGS__)

MqConfigSetStorage_RT

MQ_EXTERN void MqConfigSetStorage_RT(MK_RT const mkrt, MQ_CTX const ctx, MK_STRN data)

set the Storage value and cleanup old value

Definition at line 160 of file msgque_overload_mq.h.

◆ MqConfigSetStorage_NULL

#define MqConfigSetStorage_NULL ( ... )

Value:

MqConfigSetStorage_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 159 of file msgque_overload_mq.h.

Function Documentation

◆ MqConfigCheckStartAs()

MQ_EXTERN bool MqConfigCheckStartAs	(	MQ_CTX const	ctx,
		enum MqStartE	data )

check if MqConfigS::startAs can be set to data

Here is the caller graph for this function:

◆ MqConfigSetAllDebug_RT()

MQ_EXTERN enum MkErrorE MqConfigSetAllDebug_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MK_I32 const	data )

set the MkRuntimeS::debug value

set all childs and all slaves and the link target parter… too

◆ MqConfigSetAllTimeout()

MQ_EXTERN void MqConfigSetAllTimeout	(	MQ_CTX const	ctx,
		MK_TIME_T	data )

set the MqIoConfigS::timeout value

set all childs and all slaves too

◆ MqConfigSetBuffersize()

MQ_EXTERN void MqConfigSetBuffersize	(	MQ_CTX const	ctx,
		MK_I32	data )

set the MqIoConfigS::buffersize value

Here is the caller graph for this function:

◆ MqConfigSetDaemon_RT()

MQ_EXTERN enum MkErrorE MqConfigSetDaemon_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MK_STRN	pidfile )

start the server-context as daemon …

A daemon is a server-process without any link to the parent-process. A daemon-process has closed all default IO (e.g stdout, stdin, stderr) and forked into the background. (default: no daemon)

enum MkErrorE
MqConfigSetDaemon_RT (
  MK_RT_ARGS
  MQ_CTX const ctx,
  MK_STRN pidfile
) {
  MK_RT_ATTR_HDL_CHECK(ctx);
  MK_RT_ATTR_CHECK_RUNTIME_XN(ctx);
  if (MQ_IS_SERVER(ctx)) {
    if (MqContextCT_X(ctx)->ignoreFork == true) {
      return MkErrorDbV_1_XS (MK_ERROR_OPTION_FORBIDDEN, "--daemon", "current");
    } else {
      MkErrorCheck (MkSysDaemonize(MkOBJ(ctx), pidfile));
      MkRuntimeSetIsSilent (true);
    }
  } else {
    return MkErrorDbV_1_XS (MK_ERROR_OPTION_FORBIDDEN, "--daemon", "client");
  }
  return MK_OK;
error:
  return MkErrorStack_1X(ctx);
}

Attention: this option require the fork system-call and is not compatible with threads.

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	ctx	the MqContextS instance to work on
[in]	pidfile	write the PID of the daemon into this file (default: NULL, do not start as daemon)

Exceptions

MkExceptionC → The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqConfigSetIdentFrom()

MQ_EXTERN void MqConfigSetIdentFrom	(	MQ_CTX const	ctx,
		enum MqIdentE	data )

set the MqConfigS::identFrom value

Here is the caller graph for this function:

◆ MqConfigSetIgnoreExit()

MQ_EXTERN void MqConfigSetIgnoreExit	(	MQ_CTX const	ctx,
		bool	data )

set the MqSetupS::ignoreExit value

Here is the caller graph for this function:

◆ MqConfigSetIoPipe_RT()

MQ_EXTERN enum MkErrorE MqConfigSetIoPipe_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MQ_SOCK_HDL	fh )

set the pipe configuration data …

This is configuration option is only useful for a (x)inetd setup to use the stdin (socket=0) as send/recv communication socket

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	ctx	the MqContextS instance to work on
[in]	fh	the name of the known socket

Exceptions

MkExceptionC → The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqConfigSetIoTcp_RT()

MQ_EXTERN enum MkErrorE MqConfigSetIoTcp_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MK_STRN	host,
		MK_STRN	port,
		MK_STRN	myhost,
		MK_STRN	myport )

configure a context to use a tcp-client-server-link …

Parameters

[in]	host	client: name of the remote interface (default: localhost) server: name of the local interface (default: listen on all interfaces)
[in]	port	client: name of the remote port server: name of the local port
[in]	myhost	client: name of the local interface
[in]	myport	client: name of the local port
[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	ctx	the MqContextS instance to work on

Exceptions

MkExceptionC → The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqConfigSetIoTcpL_RT()

MQ_EXTERN enum MkErrorE MqConfigSetIoTcpL_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MK_BFL const	vals )

configure a context to use a tcp-client-server-link …

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	ctx	the MqContextS instance to work on
[in]	vals	a list with `host, port, myhost, myport`

Exceptions

MkExceptionC → The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqConfigSetIoUds_RT()

MQ_EXTERN enum MkErrorE MqConfigSetIoUds_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MK_STRN	file )

configure a context to use a uds-client-server-link …

The uds-socket (http://en.wikipedia.org/wiki/Unix_domain_socket) is usually 50% faster than a local tcp communication but only available on UNIX.

Parameters

[in]	file	name of a uds-socket-file (default: `None`)
[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	ctx	the MqContextS instance to work on

Exceptions

MkExceptionC → The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqConfigSetIsServer()

MQ_EXTERN void MqConfigSetIsServer	(	MQ_CTX const	ctx,
		bool	data )

set the MqSetupS::isServer value

Here is the caller graph for this function:

◆ MqConfigSetIsString()

MQ_EXTERN void MqConfigSetIsString	(	MQ_CTX const	ctx,
		bool	data )

set the MqConfigS::native value 'S'string or 'L'owEndian or 'B'igEndian

Attention: only the client can set this option... the server get this option from the client and using this function is ignored.

Here is the caller graph for this function:

◆ MqConfigSetName_RT()

MQ_EXTERN void MqConfigSetName_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MK_STRN	data )

set the MqConfigS::dispname value and cleanup old value

◆ MqConfigSetPkgsize()

MQ_EXTERN void MqConfigSetPkgsize	(	MQ_CTX const	ctx,
		MK_I32	data )

set the MqIoConfigS::pkgsize value

Here is the caller graph for this function:

◆ MqConfigSetPostfix_RT()

MQ_EXTERN void MqConfigSetPostfix_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MK_STRN	data )

set the client-part (2) of the application-identifer MqConfigS::dispname …

The postfix is used for:

MqConfigS::dispname initialization

The postfix is initialize with:

an empty string
the ctx.ConfigSetPostfix(data:string) function
the client postfix at server-startup
the --postfix string option

Attention: if the --name string is explicitly set, then --prefix string and --postfix string have no effect

◆ MqConfigSetPrefix_RT()

MQ_EXTERN void MqConfigSetPrefix_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MK_STRN	data )

set the server-part (1) of the application-identifer MqConfigS::dispname …

The prefix is used for:

MqConfigS::dispname initialization
application-identifer if --ident-from prefix|factory is set to prefix (default)
groupname in --config fileName is used as application-identifer

The prefix is initialize with:

the basename of the executable if NO factory is used
the MqFactoryS::originalIdent
the ctx.ConfigSetPrefix(data:string) or the ctx.ConfigSetName(data:string) function
the --name string OR the --prefix string option

Attention: if the --name string is explicitly set, then --prefix string and --postfix string have no effect

◆ MqConfigSetPrefixWithNoLock_RT()

MQ_EXTERN void MqConfigSetPrefixWithNoLock_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MK_STRN	data )

set the MqConfigS::prefix with low-priority …

The following steps are performed :

only set if data is non None
only set if the MqConfigS::bits→prefixLOCK is false
after set the RCNs{ConfigS::bits}→prefixLOCK is not set to true
after set the RCNs{ConfigS::name} is updated

◆ MqConfigSetStartAs()

MQ_EXTERN enum MkErrorE MqConfigSetStartAs	(	MQ_CTX const	ctx,
		enum MqStartE	data )

set the MqConfigS::startAs value

Here is the caller graph for this function:

◆ MqConfigSetStartAsString()

MQ_EXTERN enum MkErrorE MqConfigSetStartAsString	(	MQ_CTX const	ctx,
		MK_STRN	data )

set the MqConfigS::startAs value using string default, thread, fork or spawn

Here is the caller graph for this function:

◆ MqConfigSetStorage_RT()

MQ_EXTERN void MqConfigSetStorage_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MK_STRN	data )

set the Storage value and cleanup old value

◆ MqConfigSetTimeout()

MQ_EXTERN void MqConfigSetTimeout	(	MQ_CTX const	ctx,
		MK_TIME_T	data )

set the MqIoConfigS::timeout value

Here is the caller graph for this function:

Functions

MqContextC - MqContextC_ConfigApi_Set_C_API - overload

Detailed Description

Macro Definition Documentation

◆ MqConfigSetAllDebug

◆ MqConfigSetAllDebug_C

◆ MqConfigSetAllDebug_E

◆ MqConfigSetAllDebug_NULL

◆ MqConfigSetDaemon

◆ MqConfigSetDaemon_C

◆ MqConfigSetDaemon_E

◆ MqConfigSetDaemon_NULL

◆ MqConfigSetIoPipe

◆ MqConfigSetIoPipe_C

◆ MqConfigSetIoPipe_E

◆ MqConfigSetIoPipe_NULL

◆ MqConfigSetIoTcp

◆ MqConfigSetIoTcp_1

◆ MqConfigSetIoTcp_2

◆ MqConfigSetIoTcp_3

◆ MqConfigSetIoTcp_4

◆ MqConfigSetIoTcp_C

◆ MqConfigSetIoTcp_E

◆ MqConfigSetIoTcp_NULL

◆ MqConfigSetIoTcpL

◆ MqConfigSetIoTcpL_C

◆ MqConfigSetIoTcpL_E

◆ MqConfigSetIoTcpL_NULL

◆ MqConfigSetIoUds

◆ MqConfigSetIoUds_C

◆ MqConfigSetIoUds_E

◆ MqConfigSetIoUds_NULL

◆ MqConfigSetName

◆ MqConfigSetName_NULL

◆ MqConfigSetPostfix

◆ MqConfigSetPostfix_NULL

◆ MqConfigSetPrefix

◆ MqConfigSetPrefix_NULL

◆ MqConfigSetPrefixWithNoLock

◆ MqConfigSetPrefixWithNoLock_NULL

◆ MqConfigSetStartAs_C

◆ MqConfigSetStartAs_E

◆ MqConfigSetStartAsString_C

◆ MqConfigSetStartAsString_E

◆ MqConfigSetStorage

◆ MqConfigSetStorage_NULL

Function Documentation

◆ MqConfigCheckStartAs()

◆ MqConfigSetAllDebug_RT()

◆ MqConfigSetAllTimeout()

◆ MqConfigSetBuffersize()

◆ MqConfigSetDaemon_RT()

◆ MqConfigSetIdentFrom()

◆ MqConfigSetIgnoreExit()

◆ MqConfigSetIoPipe_RT()

◆ MqConfigSetIoTcp_RT()

◆ MqConfigSetIoTcpL_RT()

◆ MqConfigSetIoUds_RT()

◆ MqConfigSetIsServer()

◆ MqConfigSetIsString()

◆ MqConfigSetName_RT()

◆ MqConfigSetPkgsize()

◆ MqConfigSetPostfix_RT()

◆ MqConfigSetPrefix_RT()

◆ MqConfigSetPrefixWithNoLock_RT()

◆ MqConfigSetStartAs()

◆ MqConfigSetStartAsString()

◆ MqConfigSetStorage_RT()

◆ MqConfigSetTimeout()