MqContextC - various function to 'get' the configuration-data from a context … More...
Functions | |
bool | MqConfigGetIsServer (MQ_CTX const ctx) |
does the context object is a server ? | |
enum MqIdentE | MqConfigGetIdentFrom (MQ_CTX const ctx) |
get the MqConfigS::identFrom | |
bool | MqConfigGetIsParent (MQ_CTX const ctx) |
does the context object is a parent ? An objext is a parent id the MqConfigS::parent attribute is MK_NULL | |
bool | MqConfigGetIsString (MQ_CTX const ctx) |
does the context object is using the string-mode ? | |
MK_STRN | MqConfigGetName (MQ_CTXN const ctx) |
get the name of the context object | |
MK_STRN | MqConfigGetPrefix (MQ_CTXN const ctx) |
get the MqConfigS::prefix | |
MK_STRN | MqConfigGetPostfix (MQ_CTXN const ctx) |
get the MqConfigS::postfix | |
MK_STRN | MqConfigGetStorage (MQ_CTXN const ctx) |
get the storage of the context object | |
MK_I32 | MqConfigGetBuffersize (MQ_CTXN const ctx) |
get the minimum of the read/send buffersize of the socket | |
MK_I32 | MqConfigGetPkgsize (MQ_CTXN const ctx) |
get the maximun size of a BDY package | |
MK_TIME_T | MqConfigGetTimeout (MQ_CTXN const ctx) |
get the timeout value of the context object | |
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) |
get the configuration-data of the tcp-client-server-link … | |
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 … | |
MQ_SOCK_HDL | MqConfigGetIoPipe (MQ_CTX const ctx) |
return the MqIoPipeConfigS | |
enum MqStartE | MqConfigGetStartAs (MQ_CTX const ctx) |
return the MqConfigS::startAs value | |
enum MqStatusIsEF | MqConfigGetStatusIs (MQ_CTX const ctx) |
return the MqContextS::statusIs value | |
MQ_EXTERN config_t * | MqConfigGetConfigFile (MQ_CTX const ctx) |
get the config-file handle used for libconfig API funtions | |
MQ_EXTERN config_setting_t * | MqConfigGetConfigRoot (MQ_CTX const ctx) |
get the config-root handle used for libconfig API funtions | |
MQ_EXTERN enum MkErrorE | MqConfigSetConfigFile_RT (MK_RT 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 - 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(...) |
MqContextC - various function to 'get' the configuration-data from a context …
#define MQ_GET_MASTER | ( | ctx | ) |
Definition at line 2414 of file LibMqMsgque_mq.h.
#define MQ_GET_PARENT | ( | ctx | ) |
Definition at line 2413 of file LibMqMsgque_mq.h.
#define MQ_IS_CHILD | ( | ctx | ) |
Definition at line 2407 of file LibMqMsgque_mq.h.
#define MQ_IS_CLIENT | ( | ctx | ) |
Definition at line 2405 of file LibMqMsgque_mq.h.
#define MQ_IS_CLIENT_PARENT | ( | ctx | ) |
Definition at line 2406 of file LibMqMsgque_mq.h.
#define MQ_IS_LOOPBACK | ( | ctx | ) |
Definition at line 2411 of file LibMqMsgque_mq.h.
#define MQ_IS_MASTER | ( | ctx | ) |
Definition at line 2410 of file LibMqMsgque_mq.h.
#define MQ_IS_PARENT | ( | ctx | ) |
Definition at line 2408 of file LibMqMsgque_mq.h.
#define MQ_IS_SERVER | ( | ctx | ) |
extract boolean information from context
Definition at line 2403 of file LibMqMsgque_mq.h.
#define MQ_IS_SERVER_PARENT | ( | ctx | ) |
Definition at line 2404 of file LibMqMsgque_mq.h.
#define MQ_IS_SLAVE | ( | ctx | ) |
Definition at line 2409 of file LibMqMsgque_mq.h.
#define MqConfigGetIoTcp_C | ( | ... | ) |
Definition at line 77 of file msgque_overload_mq.h.
#define MqConfigGetIoTcp_E | ( | ... | ) |
Definition at line 76 of file msgque_overload_mq.h.
#define MqConfigGetIoTcpL_C | ( | ... | ) |
Definition at line 66 of file msgque_overload_mq.h.
#define MqConfigGetIoTcpL_E | ( | ... | ) |
Definition at line 65 of file msgque_overload_mq.h.
#define MqConfigGetIoTcpL_e | ( | ... | ) |
Definition at line 67 of file msgque_overload_mq.h.
#define MqConfigSetConfigFile | ( | ... | ) |
Definition at line 71 of file msgque_overload_mq.h.
#define MqConfigSetConfigFile_C | ( | ... | ) |
Definition at line 73 of file msgque_overload_mq.h.
#define MqConfigSetConfigFile_E | ( | ... | ) |
Definition at line 72 of file msgque_overload_mq.h.
#define MqConfigSetConfigFile_NULL | ( | ... | ) |
Definition at line 70 of file msgque_overload_mq.h.
get the minimum of the read/send buffersize of the socket
[in] | ctx | the MqContextS instance to work on |
context.config.buffersize
(R/S) value Definition at line 8367 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetBuffersize …
get the config-file handle used for libconfig API funtions
[in] | ctx | the MqContextS instance to work on |
MK_NULL
if no config-file is available. 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.
[in] | ctx | the MqContextS instance to work on |
MK_NULL
if no config-root is available. get the MqConfigS::identFrom
[in] | ctx | the MqContextS instance to work on |
prefix
or factory Definition at line 8280 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetIdentFrom …
|
inline |
return the MqIoPipeConfigS
[in] | ctx | the MqContextS instance to work on |
Definition at line 8470 of file LibMqMsgque_mq.h.
MQ_EXTERN MQ_SOCK_HDL MqConfigGetIoPipeP | ( | MQ_CTX const | ctx | ) |
Non-inline replacement for MqConfigGetIoPipe …
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 …
[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 |
MK_NULL
MK_NULL
… nothing will be done get the configuration-data of the tcp-client-server-link as MkBufferListC …
host |
| ||||
port |
| ||||
myhost | name of the local interface | ||||
myport | name of the local port |
[in] | ctx | the MqContextS instance to work on |
[out] | vals_out | the contain host, port, myhost and myport data |
return the MqIoUdsConfigS
[in] | ctx | the MqContextS instance to work on |
context.config.io.uds.file
value Definition at line 8404 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetIoUds …
|
inline |
does the context object is a parent ? An objext is a parent id the MqConfigS::parent attribute is MK_NULL
[in] | ctx | the MqContextS instance to work on |
(ctx->config.parent == NULL)
value Definition at line 8292 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetIsParent …
|
inline |
does the context object is a server ?
[in] | ctx | the MqContextS instance to work on |
(ctx->setup.isServer == true)
value Definition at line 8269 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetIsServer …
|
inline |
does the context object is using the string-mode ?
[in] | ctx | the MqContextS instance to work on |
(ctx->config.native == 'S')
value Definition at line 8303 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetIsString …
get the name of the context object
[in] | ctx | the MqContextS instance to work on |
context.config.name
value Definition at line 8316 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetName …
get the maximun size of a BDY package
[in] | ctx | the MqContextS instance to work on |
context.config.pkgsize
(R/S) value Definition at line 8379 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetPkgsize …
get the MqConfigS::postfix
[in] | ctx | the MqContextS instance to work on |
Definition at line 8342 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetPostfix …
get the MqConfigS::prefix
[in] | ctx | the MqContextS instance to work on |
Definition at line 8329 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetPrefix …
return the MqConfigS::startAs value
Definition at line 8479 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetStartAs …
|
inline |
return the MqContextS::statusIs value
Definition at line 8488 of file LibMqMsgque_mq.h.
MQ_EXTERN enum MqStatusIsEF MqConfigGetStatusIsP | ( | MQ_CTX const | ctx | ) |
Non-inline replacement for MqConfigGetStatusIs …
get the storage of the context object
[in] | ctx | the MqContextS instance to work on |
context.config.storage
value Definition at line 8355 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetStorage …
get the timeout value of the context object
[in] | ctx | the MqContextS instance to work on |
context.config.timeout
value Definition at line 8391 of file LibMqMsgque_mq.h.
Non-inline replacement for MqConfigGetTimeout …
MQ_EXTERN enum MkErrorE MqConfigSetConfigFile_RT | ( | MK_RT | 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
[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 |