MqContextC - various function to 'get' the configuration-data from a context … More...

Collaboration diagram for MqContextC_ConfigApi_Get_C_API:

Functions
MK_ATTR_HDL bool	libmqmsgque::MqConfigGetIsServer (MQ_CTX const ctx)
	does the context object is a server ?

MK_ATTR_HDL enum MqIdentE	libmqmsgque::MqConfigGetIdentFrom (MQ_CTX const ctx)
	get the libmqmsgque::MqConfigS::identFrom

MK_ATTR_HDL bool	libmqmsgque::MqConfigGetIsParent (MQ_CTX const ctx)
	does the context object is a parent ? An objext is a parent id the libmqmsgque::MqConfigS::parent attribute is `MK_NULL`

MK_ATTR_HDL bool	libmqmsgque::MqConfigGetIsString (MQ_CTX const ctx)
	does the context object is using the string-mode ?

MK_ATTR_HDL MK_STRN	libmqmsgque::MqConfigGetName (MQ_CTXN const ctx)
	get the name of the context object

MK_ATTR_HDL MK_STRN	libmqmsgque::MqConfigGetPrefix (MQ_CTXN const ctx)
	get the libmqmsgque::MqConfigS::prefix

MK_ATTR_HDL MK_STRN	libmqmsgque::MqConfigGetPostfix (MQ_CTXN const ctx)
	get the libmqmsgque::MqConfigS::postfix

MK_ATTR_HDL MK_STRN	libmqmsgque::MqConfigGetStorage (MQ_CTXN const ctx)
	get the storage of the context object

MK_ATTR_HDL MK_I32	libmqmsgque::MqConfigGetBuffersize (MQ_CTXN const ctx)
	get the minimum of the read/send buffersize of the socket

MK_ATTR_HDL MK_I32	libmqmsgque::MqConfigGetPkgsize (MQ_CTXN const ctx)
	get the maximun size of a BDY package

MK_ATTR_HDL MK_TIME_T	libmqmsgque::MqConfigGetTimeout (MQ_CTXN const ctx)
	get the timeout value of the context object

MK_ATTR_HDL MK_STRN	libmqmsgque::MqConfigGetIoUds (MQ_CTXN const ctx)
	return the libmqmsgque::MqIoUdsConfigS

MQ_EXTERN enum MkErrorE	libmqmsgque::MqConfigGetIoTcp (MQ_CTX const ctx, MK_STRN host_out, MK_STRN port_out, MK_STRN myhost_out, MK_STRN myport_out) MK_ATTR_HDL
	get the configuration-data of the tcp-client-server-link …

MQ_EXTERN enum MkErrorE	libmqmsgque::MqConfigGetIoTcpL (MQ_CTX const ctx, MK_BFL *vals_out) MK_ATTR_HDL
	get the configuration-data of the tcp-client-server-link as MkBufferListC …

MK_ATTR_HDL MQ_SOCK_HDL	libmqmsgque::MqConfigGetIoPipe (MQ_CTX const ctx)
	return the libmqmsgque::MqIoPipeConfigS

MK_ATTR_HDL enum MqStartE	libmqmsgque::MqConfigGetStartAs (MQ_CTX const ctx)
	return the libmqmsgque::MqConfigS::startAs value

MK_ATTR_HDL enum MqStatusIsEF	libmqmsgque::MqConfigGetStatusIs (MQ_CTX const ctx)
	return the libmqmsgque::MqContextS::statusIs value

MQ_EXTERN config_t *	libmqmsgque::MqConfigGetConfigFile (MQ_CTX const ctx) MK_ATTR_HDL
	get the config-file handle used for libconfig API funtions

MQ_EXTERN config_setting_t *	libmqmsgque::MqConfigGetConfigRoot (MQ_CTX const ctx) MK_ATTR_HDL
	get the config-root handle used for libconfig API funtions

MQ_EXTERN enum MkErrorE	libmqmsgque::MqConfigSetConfigFile_RT (MK_RT const mkrt, MQ_CTX const ctx, MK_STRN const filename)
	set the config-file and parse for well-known config-items

#define	MQ_IS_SERVER(ctx)
	extract boolean information from context

#define	MQ_IS_SERVER_PARENT(ctx)

#define	MQ_IS_CLIENT(ctx)

#define	MQ_IS_CLIENT_PARENT(ctx)

#define	MQ_IS_CHILD(ctx)

#define	MQ_IS_PARENT(ctx)

#define	MQ_IS_SLAVE(ctx)

#define	MQ_IS_MASTER(ctx)

#define	MQ_IS_LOOPBACK(ctx)

#define	MQ_GET_PARENT(ctx)

#define	MQ_GET_MASTER(ctx)

MqContextC - MqContextC_ConfigApi_Get_C_API - overload
#define	MqConfigGetIoTcpL_E(...)

#define	MqConfigGetIoTcpL_C(...)

#define	MqConfigGetIoTcpL_e(...)

#define	MqConfigSetConfigFile_NULL(...)

#define	MqConfigSetConfigFile(...)

#define	MqConfigSetConfigFile_E(...)

#define	MqConfigSetConfigFile_C(...)

#define	MqConfigGetIoTcp_E(...)

#define	MqConfigGetIoTcp_C(...)

Detailed Description

MqContextC - various function to 'get' the configuration-data from a context …

Macro Definition Documentation

◆ MQ_GET_MASTER

#define MQ_GET_MASTER ( ctx )

Value:

(MQ_IS_SLAVE(ctx) ? ctx->config.master : ctx)

MQ_IS_SLAVE

#define MQ_IS_SLAVE(ctx)

Definition LibMqMsgque_mq.h:2397

Definition at line 2402 of file LibMqMsgque_mq.h.

◆ MQ_GET_PARENT

#define MQ_GET_PARENT ( ctx )

Value:

(MQ_IS_CHILD(ctx) ? ctx->link.ctxIdP : ctx)

MQ_IS_CHILD

#define MQ_IS_CHILD(ctx)

Definition LibMqMsgque_mq.h:2395

Definition at line 2401 of file LibMqMsgque_mq.h.

◆ MQ_IS_CHILD

#define MQ_IS_CHILD ( ctx )

Value:

((ctx)->config.parent != NULL)

Definition at line 2395 of file LibMqMsgque_mq.h.

◆ MQ_IS_CLIENT

#define MQ_IS_CLIENT ( ctx )

Value:

(ctx->setup.isServer == false)

Definition at line 2393 of file LibMqMsgque_mq.h.

◆ MQ_IS_CLIENT_PARENT

#define MQ_IS_CLIENT_PARENT ( ctx )

Value:

(MQ_IS_CLIENT(ctx) && MQ_IS_PARENT(ctx))

MQ_IS_PARENT

#define MQ_IS_PARENT(ctx)

Definition LibMqMsgque_mq.h:2396

MQ_IS_CLIENT

#define MQ_IS_CLIENT(ctx)

Definition LibMqMsgque_mq.h:2393

Definition at line 2394 of file LibMqMsgque_mq.h.

◆ MQ_IS_LOOPBACK

#define MQ_IS_LOOPBACK ( ctx )

Value:

((ctx)->config.io.com == MQ_IO_LOOP)

Definition at line 2399 of file LibMqMsgque_mq.h.

◆ MQ_IS_MASTER

#define MQ_IS_MASTER ( ctx )

Value:

((ctx)->config.master == NULL)

Definition at line 2398 of file LibMqMsgque_mq.h.

◆ MQ_IS_PARENT

#define MQ_IS_PARENT ( ctx )

Value:

((ctx)->config.parent == NULL)

Definition at line 2396 of file LibMqMsgque_mq.h.

◆ MQ_IS_SERVER

#define MQ_IS_SERVER ( ctx )

Value:

(ctx->setup.isServer == true)

extract boolean information from context

Definition at line 2391 of file LibMqMsgque_mq.h.

◆ MQ_IS_SERVER_PARENT

#define MQ_IS_SERVER_PARENT ( ctx )

Value:

(MQ_IS_SERVER(ctx) && MQ_IS_PARENT(ctx))

MQ_IS_SERVER

#define MQ_IS_SERVER(ctx)

extract boolean information from context

Definition LibMqMsgque_mq.h:2391

Definition at line 2392 of file LibMqMsgque_mq.h.

◆ MQ_IS_SLAVE

#define MQ_IS_SLAVE ( ctx )

Value:

((ctx)->config.master != NULL)

Definition at line 2397 of file LibMqMsgque_mq.h.

◆ MqConfigGetIoTcp_C

#define MqConfigGetIoTcp_C ( ... )

Value:

if (MkErrorCheckI(MqConfigGetIoTcp(__VA_ARGS__)))

Definition at line 77 of file msgque_overload_mq.h.

◆ MqConfigGetIoTcp_E

#define MqConfigGetIoTcp_E ( ... )

Value:

MkErrorCheck(MqConfigGetIoTcp(__VA_ARGS__))

Definition at line 76 of file msgque_overload_mq.h.

◆ MqConfigGetIoTcpL_C

#define MqConfigGetIoTcpL_C ( ... )

Value:

if (MkErrorCheckI(MqConfigGetIoTcpL(__VA_ARGS__)))

Definition at line 66 of file msgque_overload_mq.h.

◆ MqConfigGetIoTcpL_E

#define MqConfigGetIoTcpL_E ( ... )

Value:

MkErrorCheck(MqConfigGetIoTcpL(__VA_ARGS__))

Definition at line 65 of file msgque_overload_mq.h.

◆ MqConfigGetIoTcpL_e

#define MqConfigGetIoTcpL_e ( ... )

Value:

MK_EMBEDDED(MK_BFL,MqConfigGetIoTcpL,__VA_ARGS__)

MK_EMBEDDED

#define MK_EMBEDDED(type, call,...)

Definition at line 67 of file msgque_overload_mq.h.

◆ MqConfigSetConfigFile

#define MqConfigSetConfigFile ( ... )

Value:

MqConfigSetConfigFile_RT(MK_RT_CALL __VA_ARGS__)

MK_RT_CALL

#define MK_RT_CALL

Definition at line 71 of file msgque_overload_mq.h.

◆ MqConfigSetConfigFile_C

#define MqConfigSetConfigFile_C ( ... )

Value:

if (MkErrorCheckI(MqConfigSetConfigFile(__VA_ARGS__)))

MqConfigSetConfigFile

#define MqConfigSetConfigFile(...)

Definition msgque_overload_mq.h:71

Definition at line 73 of file msgque_overload_mq.h.

◆ MqConfigSetConfigFile_E

#define MqConfigSetConfigFile_E ( ... )

Value:

MkErrorCheck(MqConfigSetConfigFile(__VA_ARGS__))

Definition at line 72 of file msgque_overload_mq.h.

◆ MqConfigSetConfigFile_NULL

#define MqConfigSetConfigFile_NULL ( ... )

Value:

MqConfigSetConfigFile_RT(MK_RT_CALL_NULL __VA_ARGS__)

MK_RT_CALL_NULL

#define MK_RT_CALL_NULL

Definition at line 70 of file msgque_overload_mq.h.

Function Documentation

◆ MqConfigGetBuffersize()

MK_ATTR_HDL MK_I32 libmqmsgque::MqConfigGetBuffersize ( MQ_CTXN const ctx )

inline

get the minimum of the read/send buffersize of the socket

Parameters

[in] ctx the MqContextS instance to work on

Returns: the context.config.buffersize(R/S) value

Definition at line 8315 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return (ctx)->config.io.buffersize;
}

Here is the caller graph for this function:

◆ MqConfigGetConfigFile()

MQ_EXTERN config_t * libmqmsgque::MqConfigGetConfigFile ( MQ_CTX const ctx )

get the config-file handle used for libconfig API funtions

Parameters

[in] ctx the MqContextS instance to work on

Returns: the libmqmsgque::MqConfigS::cfg value or MK_NULL if no config-file is available.

◆ MqConfigGetConfigRoot()

MQ_EXTERN config_setting_t * libmqmsgque::MqConfigGetConfigRoot ( MQ_CTX const ctx )

get the config-root handle used for libconfig API funtions

The root is the place in the config-file which belongs to the MqClassIdentGet application name.

Parameters

[in] ctx the MqContextS instance to work on

Returns: the libmqmsgque::MqConfigS::rootH value or MK_NULL if no config-root is available.

◆ MqConfigGetIdentFrom()

MK_ATTR_HDL enum MqIdentE libmqmsgque::MqConfigGetIdentFrom ( MQ_CTX const ctx )

inline

get the libmqmsgque::MqConfigS::identFrom

Parameters

[in] ctx the MqContextS instance to work on

Returns: prefix or factory

Definition at line 8235 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return ctx->config.identFrom;
}

Here is the caller graph for this function:

◆ MqConfigGetIoPipe()

MK_ATTR_HDL MQ_SOCK_HDL libmqmsgque::MqConfigGetIoPipe ( MQ_CTX const ctx )

inline

return the libmqmsgque::MqIoPipeConfigS

Parameters

[in] ctx the MqContextS instance to work on

Definition at line 8414 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return ctx->config.io.pipe.hdl;
}

Here is the caller graph for this function:

◆ MqConfigGetIoTcp()

MQ_EXTERN enum MkErrorE libmqmsgque::MqConfigGetIoTcp	(	MQ_CTX const	ctx,
		MK_STRN *	host_out,
		MK_STRN *	port_out,
		MK_STRN *	myhost_out,
		MK_STRN *	myport_out )

get the configuration-data of the tcp-client-server-link …

Parameters

[in]	ctx	the MqContextS instance to work on
[out]	host_out	client: name of the remote interface (default: localhost) server: name of the local interface (default: listen on all interfaces)
[out]	port_out	client: name of the remote port server: name of the local port
[out]	myhost_out	client: name of the local interface
[out]	myport_out	client: name of the local port

Exceptions

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

Attention

if the config-value is not defined… the out-value will be set to MK_NULL
if the the out-value is MK_NULL … nothing will be done

Here is the caller graph for this function:

◆ MqConfigGetIoTcpL()

MQ_EXTERN enum MkErrorE libmqmsgque::MqConfigGetIoTcpL	(	MQ_CTX const	ctx,
		MK_BFL *	vals_out )

get the configuration-data of the tcp-client-server-link as MkBufferListC …

host

client	name of the remote interface (default: localhost)
server	name of the local interface (default: listen on all interfaces

port

client	name of the remote port
server	name of the local port

myhost

name of the local interface

myport

name of the local port

Parameters

[in]	ctx	the MqContextS instance to work on
[out]	vals_out	the contain host, port, myhost and myport data

Exceptions

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

Attention: the vals_out is owned by ccmqmsgque ... do not free !

Here is the caller graph for this function:

◆ MqConfigGetIoUds()

MK_ATTR_HDL MK_STRN libmqmsgque::MqConfigGetIoUds ( MQ_CTXN const ctx )

inline

return the libmqmsgque::MqIoUdsConfigS

Parameters

[in] ctx the MqContextS instance to work on

Returns: the context.config.io.uds.file value

Definition at line 8349 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return MkSysStringGetNoNULL(ctx->config.io.uds.file);
}

Here is the caller graph for this function:

◆ MqConfigGetIsParent()

MK_ATTR_HDL bool libmqmsgque::MqConfigGetIsParent ( MQ_CTX const ctx )

inline

does the context object is a parent ? An objext is a parent id the libmqmsgque::MqConfigS::parent attribute is MK_NULL

Parameters

[in] ctx the MqContextS instance to work on

Returns: the (ctx->config.parent == NULL) value

Definition at line 8246 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return MQ_IS_PARENT(ctx);
}

Here is the caller graph for this function:

◆ MqConfigGetIsServer()

MK_ATTR_HDL bool libmqmsgque::MqConfigGetIsServer ( MQ_CTX const ctx )

inline

does the context object is a server ?

Parameters

[in] ctx the MqContextS instance to work on

Returns: the (ctx->setup.isServer == true) value

Definition at line 8225 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return MQ_IS_SERVER(ctx);
}

Here is the caller graph for this function:

◆ MqConfigGetIsString()

MK_ATTR_HDL bool libmqmsgque::MqConfigGetIsString ( MQ_CTX const ctx )

inline

does the context object is using the string-mode ?

Parameters

[in] ctx the MqContextS instance to work on

Returns: the (ctx->config.native == 'S') value

Definition at line 8256 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return (ctx->config.native == MK_NATIVE_IS_STRING);
}

Here is the caller graph for this function:

◆ MqConfigGetName()

MK_ATTR_HDL MK_STRN libmqmsgque::MqConfigGetName ( MQ_CTXN const ctx )

inline

get the name of the context object

Parameters

[in] ctx the MqContextS instance to work on

Returns: the context.config.name value

Attention: the string is owned by ccmqmsgque -> do not free !!

Definition at line 8268 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return MkSysStringGetNoNULL((ctx)->config.dispname);
}

Here is the caller graph for this function:

◆ MqConfigGetPkgsize()

MK_ATTR_HDL MK_I32 libmqmsgque::MqConfigGetPkgsize ( MQ_CTXN const ctx )

inline

get the maximun size of a BDY package

Parameters

[in] ctx the MqContextS instance to work on

Returns: the context.config.pkgsize(R/S) value

Definition at line 8326 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return (ctx)->config.io.pkgsize;
}

Here is the caller graph for this function:

◆ MqConfigGetPostfix()

MK_ATTR_HDL MK_STRN libmqmsgque::MqConfigGetPostfix ( MQ_CTXN const ctx )

inline

get the libmqmsgque::MqConfigS::postfix

Parameters

[in] ctx the MqContextS instance to work on

Returns: the value requested

Attention: the string is owned by ccmqmsgque -> do not free !!

Definition at line 8292 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return MkSysStringGetNoNULL((ctx)->config.postfix);
}

Here is the caller graph for this function:

◆ MqConfigGetPrefix()

MK_ATTR_HDL MK_STRN libmqmsgque::MqConfigGetPrefix ( MQ_CTXN const ctx )

inline

get the libmqmsgque::MqConfigS::prefix

Parameters

[in] ctx the MqContextS instance to work on

Returns: the value requested

Attention: the string is owned by ccmqmsgque -> do not free !!

Definition at line 8280 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return MkSysStringGetNoNULL((ctx)->config.prefix);
}

Here is the caller graph for this function:

◆ MqConfigGetStartAs()

MK_ATTR_HDL enum MqStartE libmqmsgque::MqConfigGetStartAs ( MQ_CTX const ctx )

inline

return the libmqmsgque::MqConfigS::startAs value

Definition at line 8422 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return ctx->config.startAs;
}

Here is the caller graph for this function:

◆ MqConfigGetStatusIs()

MK_ATTR_HDL enum MqStatusIsEF libmqmsgque::MqConfigGetStatusIs ( MQ_CTX const ctx )

inline

return the libmqmsgque::MqContextS::statusIs value

Definition at line 8430 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return ctx->statusIs;
}

Here is the caller graph for this function:

◆ MqConfigGetStorage()

MK_ATTR_HDL MK_STRN libmqmsgque::MqConfigGetStorage ( MQ_CTXN const ctx )

inline

get the storage of the context object

Parameters

[in] ctx the MqContextS instance to work on

Returns: the context.config.storage value

Attention: the string is owned by ccmqmsgque -> do not free !!

Definition at line 8304 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return MkSysStringGetNoNULL((ctx)->config.storage);
}

Here is the caller graph for this function:

◆ MqConfigGetTimeout()

MK_ATTR_HDL MK_TIME_T libmqmsgque::MqConfigGetTimeout ( MQ_CTXN const ctx )

inline

get the timeout value of the context object

Parameters

[in] ctx the MqContextS instance to work on

Returns: the context.config.timeout value

Definition at line 8337 of file LibMqMsgque_mq.h.

  {
  MK_ATTR_HDL_CHECK(ctx);
  return (ctx)->config.io.timeout;
}

Here is the caller graph for this function:

◆ MqConfigSetConfigFile_RT()

MQ_EXTERN enum MkErrorE libmqmsgque::MqConfigSetConfigFile_RT	(	MK_RT const	mkrt,
		MQ_CTX const	ctx,
		MK_STRN const	filename )

set the config-file and parse for well-known config-items

Read more at libmqmsgque::MqConfigS::cfg

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]	filename	name of the config-file for input

Exceptions

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

Functions

MqContextC - MqContextC_ConfigApi_Get_C_API - overload

Detailed Description

Macro Definition Documentation

◆ MQ_GET_MASTER

◆ MQ_GET_PARENT

◆ MQ_IS_CHILD

◆ MQ_IS_CLIENT

◆ MQ_IS_CLIENT_PARENT

◆ MQ_IS_LOOPBACK

◆ MQ_IS_MASTER

◆ MQ_IS_PARENT

◆ MQ_IS_SERVER

◆ MQ_IS_SERVER_PARENT

◆ MQ_IS_SLAVE

◆ MqConfigGetIoTcp_C

◆ MqConfigGetIoTcp_E

◆ MqConfigGetIoTcpL_C

◆ MqConfigGetIoTcpL_E

◆ MqConfigGetIoTcpL_e

◆ MqConfigSetConfigFile

◆ MqConfigSetConfigFile_C

◆ MqConfigSetConfigFile_E

◆ MqConfigSetConfigFile_NULL

Function Documentation

◆ MqConfigGetBuffersize()

◆ MqConfigGetConfigFile()

◆ MqConfigGetConfigRoot()

◆ MqConfigGetIdentFrom()

◆ MqConfigGetIoPipe()

◆ MqConfigGetIoTcp()

◆ MqConfigGetIoTcpL()

◆ MqConfigGetIoUds()

◆ MqConfigGetIsParent()

◆ MqConfigGetIsServer()

◆ MqConfigGetIsString()

◆ MqConfigGetName()

◆ MqConfigGetPkgsize()

◆ MqConfigGetPostfix()

◆ MqConfigGetPrefix()

◆ MqConfigGetStartAs()

◆ MqConfigGetStatusIs()

◆ MqConfigGetStorage()

◆ MqConfigGetTimeout()

◆ MqConfigSetConfigFile_RT()