MqContextC_ConfigApi_Get_C_API

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	MqConfigGetIsServer (MQ_CTX const ctx)
	does the context object is a server ?
MK_ATTR_HDL enum MqIdentE	MqConfigGetIdentFrom (MQ_CTX const ctx)
	get the MqConfigS::identFrom
MK_ATTR_HDL bool	MqConfigGetIsParent (MQ_CTX const ctx)
	does the context object is a parent ? An objext is a parent id the MqConfigS::parent attribute is None
MK_ATTR_HDL bool	MqConfigGetIsString (MQ_CTX const ctx)
	does the context object is using the string-mode ?
MK_ATTR_HDL MK_STRN	MqConfigGetName (MQ_CTXN const ctx)
	get the name of the context object
MK_ATTR_HDL MK_STRN	MqConfigGetPrefix (MQ_CTXN const ctx)
	get the MqConfigS::prefix
MK_ATTR_HDL MK_STRN	MqConfigGetPostfix (MQ_CTXN const ctx)
	get the MqConfigS::postfix
MK_ATTR_HDL MK_STRN	MqConfigGetStorage (MQ_CTXN const ctx)
	get the storage of the context object
MK_ATTR_HDL MK_I32	MqConfigGetBuffersize (MQ_CTXN const ctx)
	get the minimum of the read/send buffersize of the socket
MK_ATTR_HDL MK_I32	MqConfigGetPkgsize (MQ_CTXN const ctx)
	get the maximun size of a BDY package
MK_ATTR_HDL MK_TIME_T	MqConfigGetTimeout (MQ_CTXN const ctx)
	get the timeout value of the context object
MK_ATTR_HDL MK_STRN	MqConfigGetIoUds (MQ_CTXN const ctx)
	return the MqIoUdsConfigS
MQ_EXTERN enum MkErrorE	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	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	MqConfigGetIoPipe (MQ_CTX const ctx)
	return the MqIoPipeConfigS
MK_ATTR_HDL enum MqStartE	MqConfigGetStartAs (MQ_CTX const ctx)
	return the MqConfigS::startAs value
MK_ATTR_HDL enum MqStatusIsEF	MqConfigGetStatusIs (MQ_CTX const ctx)
	return the MqContextS::statusIs value
MQ_EXTERN config_t *	MqConfigGetConfigFile (MQ_CTX const ctx) MK_ATTR_HDL
	get the config-file handle used for libconfig API funtions
MQ_EXTERN config_setting_t *	MqConfigGetConfigRoot (MQ_CTX const ctx) MK_ATTR_HDL
	get the config-root handle used for libconfig API funtions
MQ_EXTERN enum MkErrorE	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

MqContextC - MqContextC_ConfigApi_Get_C_API - function
MK_I32	MqConfigGetBuffersizeP (MQ_CTXN const ctx)
	Non-inline replacement for MqConfigGetBuffersize …
enum MqIdentE	MqConfigGetIdentFromP (MQ_CTX const ctx)
	Non-inline replacement for MqConfigGetIdentFrom …
MQ_SOCK_HDL	MqConfigGetIoPipeP (MQ_CTX const ctx)
	Non-inline replacement for MqConfigGetIoPipe …
MK_STRN	MqConfigGetIoUdsP (MQ_CTXN const ctx)
	Non-inline replacement for MqConfigGetIoUds …
MK_BOOL	MqConfigGetIsParentP (MQ_CTX const ctx)
	Non-inline replacement for MqConfigGetIsParent …
MK_BOOL	MqConfigGetIsServerP (MQ_CTX const ctx)
	Non-inline replacement for MqConfigGetIsServer …
MK_BOOL	MqConfigGetIsStringP (MQ_CTX const ctx)
	Non-inline replacement for MqConfigGetIsString …
MK_STRN	MqConfigGetNameP (MQ_CTXN const ctx)
	Non-inline replacement for MqConfigGetName …
MK_I32	MqConfigGetPkgsizeP (MQ_CTXN const ctx)
	Non-inline replacement for MqConfigGetPkgsize …
MK_STRN	MqConfigGetPostfixP (MQ_CTXN const ctx)
	Non-inline replacement for MqConfigGetPostfix …
MK_STRN	MqConfigGetPrefixP (MQ_CTXN const ctx)
	Non-inline replacement for MqConfigGetPrefix …
enum MqStartE	MqConfigGetStartAsP (MQ_CTX const ctx)
	Non-inline replacement for MqConfigGetStartAs …
enum MqStatusIsEF	MqConfigGetStatusIsP (MQ_CTX const ctx)
	Non-inline replacement for MqConfigGetStatusIs …
MK_STRN	MqConfigGetStorageP (MQ_CTXN const ctx)
	Non-inline replacement for MqConfigGetStorage …
MK_TIME_T	MqConfigGetTimeoutP (MQ_CTXN const ctx)
	Non-inline replacement for MqConfigGetTimeout …
#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)

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)

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))

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))

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__)

Definition at line 67 of file msgque_overload_mq.h.

MqConfigSetConfigFile

#define MqConfigSetConfigFile

(

...

)

Value:

MqConfigSetConfigFile_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 71 of file msgque_overload_mq.h.

MqConfigSetConfigFile_C

#define MqConfigSetConfigFile_C

(

...

)

Value:

if (MkErrorCheckI(MqConfigSetConfigFile(__VA_ARGS__)))

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__)

Definition at line 70 of file msgque_overload_mq.h.

Function Documentation

MqConfigGetBuffersize()

MK_ATTR_HDL MK_I32 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:

MqConfigGetBuffersizeP()

MK_I32 MqConfigGetBuffersizeP ( MQ_CTXN const ctx )

extern

Non-inline replacement for MqConfigGetBuffersize …

MqConfigGetConfigFile()

MQ_EXTERN config_t * 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 MqConfigS::cfg value or None if no config-file is available.

MqConfigGetConfigRoot()

MQ_EXTERN config_setting_t * 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 MqConfigS::rootH value or None if no config-root is available.

MqConfigGetIdentFrom()

MK_ATTR_HDL enum MqIdentE MqConfigGetIdentFrom ( MQ_CTX const ctx )

inline

get the 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:

MqConfigGetIdentFromP()

enum MqIdentE MqConfigGetIdentFromP ( MQ_CTX const ctx )

extern

Non-inline replacement for MqConfigGetIdentFrom …

MqConfigGetIoPipe()

MK_ATTR_HDL MQ_SOCK_HDL MqConfigGetIoPipe ( MQ_CTX const ctx )

inline

return the 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:

MqConfigGetIoPipeP()

MQ_SOCK_HDL MqConfigGetIoPipeP ( MQ_CTX const ctx )

extern

Non-inline replacement for MqConfigGetIoPipe …

MqConfigGetIoTcp()

MQ_EXTERN enum MkErrorE 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 None
• if the the out-value is None … nothing will be done

Here is the caller graph for this function:

MqConfigGetIoTcpL()

MQ_EXTERN enum MkErrorE 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 pymqmsgque ... do not free !

Here is the caller graph for this function:

MqConfigGetIoUds()

MK_ATTR_HDL MK_STRN MqConfigGetIoUds ( MQ_CTXN const ctx )

inline

return the 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:

MqConfigGetIoUdsP()

MK_STRN MqConfigGetIoUdsP ( MQ_CTXN const ctx )

extern

Non-inline replacement for MqConfigGetIoUds …

MqConfigGetIsParent()

MK_ATTR_HDL bool MqConfigGetIsParent ( MQ_CTX const ctx )

inline

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

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:

MqConfigGetIsParentP()

MK_BOOL MqConfigGetIsParentP ( MQ_CTX const ctx )

extern

Non-inline replacement for MqConfigGetIsParent …

MqConfigGetIsServer()

MK_ATTR_HDL bool 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:

MqConfigGetIsServerP()

MK_BOOL MqConfigGetIsServerP ( MQ_CTX const ctx )

extern

Non-inline replacement for MqConfigGetIsServer …

MqConfigGetIsString()

MK_ATTR_HDL bool 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:

MqConfigGetIsStringP()

MK_BOOL MqConfigGetIsStringP ( MQ_CTX const ctx )

extern

Non-inline replacement for MqConfigGetIsString …

MqConfigGetName()

MK_ATTR_HDL MK_STRN 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 pymqmsgque -> 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:

MqConfigGetNameP()

MK_STRN MqConfigGetNameP ( MQ_CTXN const ctx )

extern

Non-inline replacement for MqConfigGetName …

MqConfigGetPkgsize()

MK_ATTR_HDL MK_I32 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:

MqConfigGetPkgsizeP()

MK_I32 MqConfigGetPkgsizeP ( MQ_CTXN const ctx )

extern

Non-inline replacement for MqConfigGetPkgsize …

MqConfigGetPostfix()

MK_ATTR_HDL MK_STRN MqConfigGetPostfix ( MQ_CTXN const ctx )

inline

get the MqConfigS::postfix

Parameters

[in]

ctx

the MqContextS instance to work on

Returns

the value requested

Attention

the string is owned by pymqmsgque -> 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:

MqConfigGetPostfixP()

MK_STRN MqConfigGetPostfixP ( MQ_CTXN const ctx )

extern

Non-inline replacement for MqConfigGetPostfix …

MqConfigGetPrefix()

MK_ATTR_HDL MK_STRN MqConfigGetPrefix ( MQ_CTXN const ctx )

inline

get the MqConfigS::prefix

Parameters

[in]

ctx

the MqContextS instance to work on

Returns

the value requested

Attention

the string is owned by pymqmsgque -> 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:

MqConfigGetPrefixP()

MK_STRN MqConfigGetPrefixP ( MQ_CTXN const ctx )

extern

Non-inline replacement for MqConfigGetPrefix …

MqConfigGetStartAs()

MK_ATTR_HDL enum MqStartE MqConfigGetStartAs ( MQ_CTX const ctx )

inline

return the 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:

MqConfigGetStartAsP()

enum MqStartE MqConfigGetStartAsP ( MQ_CTX const ctx )

extern

Non-inline replacement for MqConfigGetStartAs …

MqConfigGetStatusIs()

MK_ATTR_HDL enum MqStatusIsEF MqConfigGetStatusIs ( MQ_CTX const ctx )

inline

return the 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:

MqConfigGetStatusIsP()

enum MqStatusIsEF MqConfigGetStatusIsP ( MQ_CTX const ctx )

extern

Non-inline replacement for MqConfigGetStatusIs …

MqConfigGetStorage()

MK_ATTR_HDL MK_STRN 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 pymqmsgque -> 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:

MqConfigGetStorageP()

MK_STRN MqConfigGetStorageP ( MQ_CTXN const ctx )

extern

Non-inline replacement for MqConfigGetStorage …

MqConfigGetTimeout()

MK_ATTR_HDL MK_TIME_T 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:

MqConfigGetTimeoutP()

MK_TIME_T MqConfigGetTimeoutP ( MQ_CTXN const ctx )

extern

Non-inline replacement for MqConfigGetTimeout …

MqConfigSetConfigFile_RT()

MQ_EXTERN enum MkErrorE 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 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)