MqContextC - setup and manage a routing-link … More...

Collaboration diagram for MqContextC_RouteApi_Route_C_API:

Macros
#define	MQ_ROUTE_CTX_MAX 50
	maximum number of context-items in the return-array from MqRouteResolve …

Functions
enum MkErrorE	MqRouteCreate_RT (MK_RT mkrt, MQ_CTX ctx, MK_STRN route, MK_STRN service, bool overwrite)
	create/delete a routing-link between context an a service using route

enum MkErrorE	MqRouteDelete_RT (MK_RT mkrt, MQ_CTX ctx, MK_STRN route, MK_STRN service, bool overwrite)
	delete a routing-link created with MqRouteCreate

enum MkErrorE	MqRouteTraverse_RT (MK_RT mkrt, MQ_CTX ctx, MK_STRN service, MK_BAC args)
	traverse a tree down and call service if available.

MQ_CTX_A	MqRouteResolve_RT (MK_RT mkrt, MQ_CTX const ctx, MK_STRN const ident, MK_NUM const retnum)
	return a list of all context belonging to ident …

enum MkErrorE	MqRouteGetPath_RT (MK_RT mkrt, MQ_CTX const ctx, MK_STRN *path_out)
	return the absolut route-connection-string up to the current ctx …

enum MkErrorE	MqRouteGetTree_RT (MK_RT mkrt, MQ_CTX const ctx, MK_BFL *treeP_out)
	create an overview about all available routing-target and services …

MqContextC - MqContextC_RouteApi_Route_C_API - overload
#define	MqRouteGetTree_NULL(...)

#define	MqRouteGetTree(...)

#define	MqRouteGetTree_E(...)

#define	MqRouteGetTree_C(...)

#define	MqRouteGetTree_e(...)

#define	MqRouteCreate_NULL(...)

#define	MqRouteCreate(...)

#define	MqRouteCreate_3(ctx, route, service)

#define	MqRouteCreate_E(...)

#define	MqRouteCreate_C(...)

#define	MqRouteDelete_NULL(...)

#define	MqRouteDelete(...)

#define	MqRouteDelete_3(ctx, route, service)

#define	MqRouteDelete_E(...)

#define	MqRouteDelete_C(...)

#define	MqRouteResolve_NULL(...)

#define	MqRouteResolve(...)

#define	MqRouteResolve_2(ctx, ident)

#define	MqRouteTraverse_NULL(...)

#define	MqRouteTraverse(...)

#define	MqRouteTraverse_2(ctx, service)

#define	MqRouteTraverse_E(...)

#define	MqRouteTraverse_C(...)

#define	MqRouteGetPath_NULL(...)

#define	MqRouteGetPath(...)

#define	MqRouteGetPath_E(...)

#define	MqRouteGetPath_C(...)

#define	MqRouteGetPath_e(...)

Detailed Description

MqContextC - setup and manage a routing-link …

A routing-link is the connection of two context, the route-source and the route-target, with a unspecifiend number of hub-context in between using a specific service-token.

A single context is identified by the context-identifier as returned by MqClassIdentGet.

A routing-link can be created using Service-Level-Routing or Package-Level-Routing.

The Service-Level-Routing is using a round-robin-proxy-service on the hub-context to forward an incoming package to the routing-target.
The Package-Level-Routing is using a routing-database to route the data on the package-level without a service involved.

The difference between Service-Level-Routing and Package-Level-Routing is the public versa private behaviour.

The Service-Level-Routing route EVERY package send to the hub-context using the service-token to the routing-target, this behaviour is called public.
The Package-Level-Routing route ONLY the package(s) from the creator (owner) of the route, this behaviour is called private.

Summary:

The routing-link connect two context, a source-context and a target-context using multiple hub-context in between.
The routing-link is created with the command (runtime) enum MkErrorE MqRouteCreate(MQ_CTX ctx, MK_STRN route, MK_STRN service, MK_BOOL overwrite) using a route-connection-string and a service-token.
The route-connection-string has a syntax like a UNIX-path, understand an application as a tree with the initial client as the root and multiple server and slave server as directories and subdirectories with the final service as the file-data wanted.
The Service-Level-Routing is an extension of the already available MqServiceProxyRoundRobin and MqServiceProxyCtx feature.

TCP/IP layer model

The TCP/IP model define the following layers (from: https://www.geeksforgeeks.org/tcp-ip-model/) :

Network Access Layer

This layer corresponds to the combination of Data Link Layer and Physical Layer of the OSI model. It looks out for hardware addressing and the protocols present in this layer allows for the physical transmission of data.

Internet Layer

This layer parallels the functions of OSI’s Network layer. It defines the protocols which are responsible for logical transmission of data over the entire network
The main protocols residing at this layer are :

IP – stands for Internet Protocol and it is responsible for delivering packages from the source host to the destination host by looking at the IP addresses in the package headers. IP has 2 versions: IPv4 and IPv6. IPv4 is the one that most of the websites are using currently. But IPv6 is growing as the number of IPv4 addresses are limited in number when compared to the number of users.
ICMP – stands for Internet Control Message Protocol. It is encapsulated within IP datagrams and is responsible for providing hosts with information about network problems.
ARP – stands for Address Resolution Protocol. Its job is to find the hardware address of a host from a known IP address. ARP has several types: Reverse ARP, Proxy ARP, Gratuitous ARP and Inverse ARP.

Host-to-Host Layer

This layer is analogous to the transport layer of the OSI model. It is responsible for end-to-end communication and error-free delivery of data. It shields the upper-layer applications from the complexities of data.
The two main protocols present in this layer are :

Transmission Control Protocol (TCP) – It is known to provide reliable and error-free communication between end systems. It performs sequencing and segmentation of data. It also has acknowledgment feature and controls the flow of the data through flow control mechanism. It is a very effective protocol but has a lot of overhead due to such features. Increased overhead leads to increased cost.
User Datagram Protocol (UDP) – On the other hand does not provide any such features. It is the go-to protocol if your application does not require reliable transport as it is very cost-effective. Unlike TCP, which is connection-oriented protocol, UDP is connectionless.

Application Layer

This layer performs the functions of top three layers of the OSI model: Application, Presentation and Session Layer. It is responsible for node-to-node communication and controls user-interface specifications. Some of the protocols present in this layer are: HTTP, HTTPS, FTP, TFTP, Telnet, SSH, SMTP, SNMP, NTP, DNS, DHCP, NFS, X Window, LPD. Have a look at Protocols in Application Layer for some information about these protocols.
Protocols other than those present in the linked article are :

HTTP and HTTPS – HTTP stands for Hypertext transfer protocol. It is used by the World Wide Web to manage communications between web browsers and servers. HTTPS stands for HTTP-Secure. It is a combination of HTTP with SSL(Secure Socket Layer). It is efficient in cases where the browser need to fill out forms, sign in, authenticate and carry out bank transactions.
SSH – SSH stands for Secure Shell. It is a terminal emulations software similar to Telnet. The reason SSH is more preferred is because of its ability to maintain the encrypted connection. It sets up a secure session over a TCP/IP connection.
NTP – NTP stands for Network Time Protocol. It is used to synchronize the clocks on our computer to one standard time source. It is very useful in situations like bank transactions. Assume the following situation without the presence of NTP. Suppose you carry out a transaction, where your computer reads the time at 2:30 PM while the server records it at 2:28 PM. The server can crash very badly if it’s out of sync.

LibMqMsgque layer model

The libmqmsgque layer model is an extension to the TCP/IP layer model.

TCP/IP Application Layer

This layer is used for the libmqmsgque protocol - The protocol is the "language" of the libmqmsgque
library. The layer is defined as protocol-message-format and as protocol-flow-format.

protocol-message-format - Example from protocoll_mq.h → this is the "syntax" of the protocol.

struct HdrS {

MK_STRB ID[4] ;

MK_STRB native ;

MK_STRB charA ;

union HdrIU ctxId ;

MK_STRB charS ;

union HdrIU bdySize ;

MK_STRB charO ;

MK_STRB tok[HDR_TOK_LEN] ;

MK_STRB charT ;

union HdrIU transSId ;

MK_STRB charR ;

union HdrIU routeId ;

MK_STRB charC ;

MK_STRB hs ;

MK_STRB charE ;

MK_STRB tt ;

MK_STRB charF ;

};

struct BdyS {

MK_STRB ID[4] ;

//MK_STRB charN ; ///< <TT>size: 1 .............. -> total: 4 .. -> character .. -> "+"</TT>

union HdrIU numItems;

MK_STRB charE ;

};

struct LtrS {

MK_STRB ID[4] ;

//MK_STRB charN ; ///< <TT>size: 1 .............. -> total: 4 .. -> character .. -> "+"</TT>

MK_BINB ltrP[HDR_ID_SIZE] ;

MK_STRB charE ;

};

#define LTR_SIZE (3 + 1 + HDR_ID_SIZE + 1)

struct RouS {

MK_STRB ID[4] ;

//MK_STRB charN ; ///< <TT>size: 1 .............. -> total: 4 .. -> character .. -> "+"</TT>

MK_BINB rouP[HDR_ID_SIZE] ;

MK_STRB charE ;

};

#define ROU_SIZE (3 + 1 + HDR_ID_SIZE + 1)

struct PackageS {

struct HdrS hdr ;

struct BdyS bdy ;

};
protocol-flow-format - this is the "grammatic" of the protocol.

LibMqMsgque Service Layer

This layer provide the MqContextC-ServiceApi ontop of the Application Layer.

The master-slave-link is used to create a mesh of nodes defined by different parent-context. The master control the slave.

The master-slave-link is used to perform the following tasks:

report error messages from the slave-context to the master-context
to create a slave-child-context if a master-child-context is created
to delete a slave-context if a master-context is deleted

In difference to the client-server-link the master-slave-link connect two independent parent-context in the same process or thread (e.g. node). This leads to the restriction that only the master-context can be a server-context because only one server-context per node is possible.

   node-0   |           node-1/2        |   node-3/4/5
===================================================================

| <- client/server link -> | <- client/server link -> |

             | <-- master/slave link --> |

                           |- client1-0 -|- server3 ...
             |-  server1  -|
             |             |- client1-1 -|- server4 ...
  client0-0 -|
             |-  server2  -|- client1-2 -|- server5 ...

Definition of the "master-context"

the master-context is a parent-context without a child-context available.
the master-context is a client-context or a server-context.
the link between the master-context and the slave-context is done using MqSlaveWorker or MqSlaveCreate

Definition of the "slave-context"

the slave-context is a parent-context without a child-context available.
the slave-context is a client-context.
the slave-context lifetime is controlled by the master-context.
the slave-context report all error-messages to the master-context.
the slave-context is identified by a unique-slave-id starting with 0.
a special form of a slave-context is a worker-context

Definition of the "worker-context"

the worker-context is a slave-context using the image of the master-context self.
the master-context can be a server-context or a client-context.
the worker-context is created using MqSlaveWorker
the worker-context is identified by a unique-slave-id starting with 0.

Definition of the "slave-id"

the slave-id is defined at enum MqSlaveE
a slave is identified in his master-context by a slave-id
the slave-id work like a defined well-known-port-number in /etc/services
the slave-id is an integer value with valid values > 0
it is a good practice to plan the usage of your slave-id(s)

slave

slave-id	value	definition
MQ_SLAVE_MAX	1024	internal: the maximum slave-id … .
MQ_SLAVE_USER	10	internal: start of user-defined-slave-id .
MQ_SLAVE_LOOPBACK	0	internal: the loopback-slave-id, (call my own services) .
MQ_SLAVE_FILTER	1	internal: the filter-slave-id, (on a master get the filter-slave) .
MQ_SLAVE_MASTER	1	internal: the master-slave-id, (on a slave get the master) .
MQ_SLAVE_OTHER	1	internal: on the master-ctx get the slave-ctx and on the slave-ctx get the master-ctx .

range

range	definition
0 <= slave-id < MQ_SLAVE_MAX	range of valid slave-id's
0 <= slave-id < MQ_SLAVE_USER	internale usage
MQ_SLAVE_USER <= slave-id < MQ_SLAVE_MAX	external usage

Definition of the "LOOPBACK" (0) slave

   client   |           server            |
===========================================

| <--- client/server --->  | <-- loop --> |

            | <------ master/slave -----> |

  client -- | -- server -- | -- client -- #
                   ==             ==      #
                 server -- | -- client -- #

the loopback has always the slave-id = 0 .
the loopback has the same class as the parent, if reflection is not available the MqFactoryInitial is used.
the loopback is used to call a service on the same process or thread.
the loopback is a special filter without an additional process or thread to be started.
the loopback is only internal accessible
the service called by the loopback need the same attention as the service called by the filter, the context of the service is the loopback-context.
the loopback can call MqServiceCreate to create a new link between a service-token and a service-method, by default all services from the master-context (the owner of the loopback) are also accessible by the loopback.
in the service use MqSlaveGetMaster to get the master-context from the loopback-context.

Example from MyLoopServer.c → create a new loop-server

#include "common.h"

// [MyLoopServerC_Define]
typedef struct MyLoopServerS {
  struct MqContextS mqctx;    ///< link to the \libmqmsgque object
  #define mydata_size 30
  char mydata[mydata_size];   ///< define the "mydata" attribute
} MyLoopServerC;  
// [MyLoopServerC_Define]

// the MyLoopServerC class-type
static MkThreadLocal MK_TYP MyLoopServerCTT = NULL;

// service to serve all EXTERNAL requests for token "HLWO"
static enum MkErrorE HLWO_srv ( MQ_SERVICE_CALL_ARGS ) {
  // get the "loopback" context
  MQ_CTX loop = MqSlaveGet_e(mqctx,MQ_SLAVE_LOOPBACK);
  // call the LOOP service on the SAME server
  MqSend_E(loop,"W","LOOP");
  // answer HLWO with string-return from LOOP
  MqSend_E(mqctx, "R", "C", MqReadSTR_e(loop));
  return MK_OK;
error:
  return MqSendRETURN(mqctx);
}

// service to serve all INTERNAL requests for token "LOOP
static enum MkErrorE LOOP_srv ( MQ_SERVICE_CALL_ARGS ) {
  // get the "master" context 
  MyLoopServerC* master = (MyLoopServerC*)MqSlaveGetMaster(mqctx);
  // answer LOOP with data from MASTER->mydata attribute
  return MqSend(mqctx, "R", "C", master->mydata);
}

// define a service as link between the token "HLWO" and the callback "HLWO_srv"
static enum MkErrorE ServerSetup ( MQ_SERVICE_CALL_ARGS ) {
  // EXTERNAL: link the "HLWO" service with "HLWO_srv"
  MqServiceCreate_E(mqctx, "HLWO", HLWO_srv, NULL, NULL, NULL);
  // INTERNAL: link the "LOOP" service with "LOOP_srv"
  MqServiceCreate_E(MqSlaveGet_e(mqctx,MQ_SLAVE_LOOPBACK), "LOOP", LOOP_srv, NULL, NULL, NULL);
  return MK_OK;
error:
  return MkErrorStack_1X(mqctx);
}

// [MyLoopServerC_Create]
enum MkErrorE
MyLoopServerFactory ( MQ_CALLBACK_FACTORY_CTOR_ARGS )
{ 
  // create new instance using the MyLoopServerCTT class-type
  MQ_CTX const mqctx = *contextP = MqContextCreate(MyLoopServerCTT,tmpl);

  // initialize the new context
  MqConfigSetServerSetup (mqctx, ServerSetup, NULL, NULL, NULL);

  // cast the libmqmsgque-context into the MyLoopServerC-context
  MyLoopServerC* mqctxC = (MyLoopServerC*)mqctx;

  // initialize the "mydata" attribute
  strncpy(mqctxC->mydata,"Hello World",mydata_size);
  mqctxC->mydata[mydata_size-1] = '\0';

  return MK_OK;
}
// [MyLoopServerC_Create]

int main (int argc, MK_STRN argv[]) 
{
  AllRtSetup_NULL;

  // [MyLoopServerC_Init]
  // initialize the MyLoopServer class-type with existing MqContextC_TT class-type
  MyLoopServerCTT = MkTypeDup2(MqContextC_TT,"MyLoopServerC");
  MyLoopServerCTT->objsize = sizeof(struct MyLoopServerS);
  // [MyLoopServerC_Init]

  // setup commandline arguments for later use
  MK_BFL largv = MkBufferListCreateVC(argc, argv);
  MQ_CTX mqctx = NULL;

  // create "MyLoopServer" factory… and make it to the default.
  MqFactoryDefault(MqFactoryAdd_2(MyLoopServerFactory,"MyLoopServer"));
  // inspect commandline-argument for the "factory" to choose… and create a object
  MqFactoryNew_E (MqFactoryGetCalledL(largv), NULL, &mqctx);

  // start listen for incoming call's
  MqLinkCreate_E (mqctx, largv);
  MqCheckForLeftOverArguments_E (mqctx, largv);
  MqProcessEvent_E (mqctx,MQ_WAIT_FOREVER,MK_TIMEOUT_DEFAULT);
error:
  MkBufferListDelete(largv);
  MqExit_1(mqctx);
}

Performance analyse

The performance-test is created with:

pipe
- Nhi1Exec perfclient.c --parent --wrk ? @ perfserver.c
spawn, fork, thread
- Nhi1Exec -r=uds perfserver.c --spawn|fork|thread
- Nhi1Exec -r=uds perfclient.c --parent --wrk ?
the number of workers are set with the –wrk option
the cpu is a xeon with 4/8
the performance is calculated as worker-context-created / time-in-sec with a ~2sec (default) measurement period.

performance-test code:

The test-setup is done as:

  perfclient                                worker                            perfserver
  ==========                                ======                            ==========
  |
  |- loop --wrk x
    |- MqSlaveWorker(...)               ->  worker[1] 
    |- MqSend(worker[1],"E","STR0..")   ->  PerfWorker_I160(...)
                                            |- loop endless
                                              |- MqContextCreate(...)
                                              |- MqLinkCreate(...)      <->   MqContextCreate(...)
                                              |- MqContextDelete(...)   <->   MqContextDelete(...)
  |- sleep x sec
  |- loop --wrk x
    |- MqSend(worker[1],"C"..,"END0")   ->  PerfWorker_END0(...)
    |                                       |- stop loop
    |- "callback" - add number to all   <-  |- return #context

Using the worker-code:
// asynchronous call

static enum MkErrorE PerfWorker_STR0( MQ_SERVICE_CALL_ARGS ) {

MK_BFL largv = NULL;

MK_BFL pargv = NULL;

MK_I32 num = MqReadI32_e(mqctx);

pargv = MkBufferListDup(MqReadBFL_e(mqctx));

enum MkErrorE ret = MK_OK;

if (num == -1) num = 999999; // endless

// start test until "doNext" is "false" or "num" exceeds

for (int i=0; doNext && i<num; i++) {

// CREATE the context

MQ_CTX ctx = MqContextCreate(NULL, mqctx);

largv = MkBufferListDup(pargv);

MqLinkCreate_C (ctx, largv) {

MqContextErrorMove(mqctx,ctx);

MqContextDelete(ctx);

goto error;

}

//MqSend(ctx,"E","MARK:C","start");

MkBufferListDelete(largv);

// DELETE the context

MqContextDelete(ctx);

// count the loops

worker_count++;

// give PerfWorker_END0 time to update "doNext"

MqProcessEvent(mqctx, MQ_WAIT_NO, MK_TIMEOUT_DEFAULT);

}

end:

//printV("ret=%i, Delete=%p\n", ret, largv)

MkBufferListDelete(largv);

MkBufferListDelete(pargv);

if (doNext == true) {

// finish the test WITHOUT "END0" -> test on --num, answer required.

MqSend_E(mqctx, "R", "I", worker_count);

}

return ret;

error:

if (doNext == true) {

ret = MkErrorStack_1X(mqctx);

} else {

ret = MkErrorReset_1X(mqctx);

}

goto end;

}

performance-test results:

results generated using the debug environment

setup	–wrk	# worker-context	performance	info
pipe	1	2500	1000	the pipe start a new worker-context with spawn
spawn	1	2500	<1000	same as pipe but use network-protocoll
fork	1	3800	4000	the fork is faster than spawn
thread	1	16500	9000	the thread is faster than fork
pipe	4	8000	4500	the worker scale linear up to number of processors
spawn	4	7600	<4500	-
fork	4	23200	11500	-
thread	4	55500	27500	-
pipe	8	10000	5500	the additional scaling up to the max hyper-threading does not really help
spawn	8	9100	<5500	-
fork	8	23200	11500	-
thread	8	55500	27500	-

example (C++ syntax)

Route-Connection-String

A client-server connection is defined with the route-connection-string as a composition of "identifier" and is build like a UNIX directory tree with the initial client as root.

Example: GUI/Data Frontend

*
 
               |-header
         |-GUI-|
frontend-|     |-footer
         |
         |-DB
 
*

With --ident-from prefix|factory the identifier is defined as prefix-identifier or factory-identifer.

A route-connection-string is the path between TWO locations in the tree using the UNIX syntax:

short	syntax	direction
dot	.	current-context
double-dot	..	previous-context
slash	/	root-context (the client)
"string"	xxx	next-context with name xxx

path between "DB" and "header"

relative: ctx.RouteCreate("../GUI/header",service)
absolute: ctx.RouteCreate("/frontend/GUI/header",service)

path between "footer" and "DB"

relative: ctx.RouteCreate("../../DB",service)
absolute: ctx.RouteCreate("/frontend/DB",service)

path between "frontend" and "footer"

relative: ctx.RouteCreate("GUI/footer",service)
absolute: ctx.RouteCreate("/frontend/GUI/footer",service)

Service-Layer-Routing

The LibMqMsgque-Service-Layer-Routing create proxy-services (MqServiceProxyRoundRobin ...) between frontend and footer. (example c++)

// 1. on "frontend" create a route to the service "MYSV" on the "footer" passing "GUI"
DOING: frontendCtx.RouteCreate("GUI/footer", "MYSV");
 
// 2. on "frontend" call the route using the "loopback" slave
DOING: frontendCtx.SlaveGet(MQ_SLAVE_LOOPBACK).Send("W", "MYSV:..@..", ..);
 
// 3. on "frontend/GUI" proxy "footer"
INTERNAL: frontendCtx.ServiceProxyRoundRobin("MYSV", GUICtx);
INTERNAL: GUICtx.ServiceProxyRoundRobin("MYSV", footerCtx);
 
// 4. on "footer" call the service "MYSV"
SETUP: footerCtx.ServiceCreate("MYSV", ...);

The MqRouteCreate will take the following action:

create a round-robin-proxy on frontend and on GUI using service MYSV
check if service MYSV is available on footer

Attention:

With the proxy on frontend/GUI no other service with the name MYSV on frontend/GUI is possible and every service-call to frontend or GUI using the service MYSV will be redirected to the service MYSV on footer.
The live-time of the Service-Layer-Routing is up to the next MqRouteDelete call using the same arguments. If the proxy-to-footer becomes invalid on a the GUI-context the routing-link will be recreated.
The MqRouteCreate can be used multiple times with the same Route-Connection-String and service-token and overwrite=true to guarantee that a route is available.

Package-Layer-Routing

...

Macro Definition Documentation

◆ MQ_ROUTE_CTX_MAX

#define MQ_ROUTE_CTX_MAX 50

maximum number of context-items in the return-array from MqRouteResolve …

The maximum size of the return-array is MQ_ROUTE_CTX_MAX+1 because there is always an additional MK_NULL item at the end.

Definition at line 5681 of file LibMqMsgque_mq.h.

◆ MqRouteCreate

#define MqRouteCreate ( ... )

Value:

MqRouteCreate_RT(MK_RT_CALL __VA_ARGS__)

MK_RT_CALL

#define MK_RT_CALL

MqRouteCreate_RT

enum MkErrorE MqRouteCreate_RT(MK_RT mkrt, MQ_CTX ctx, MK_STRN route, MK_STRN service, bool overwrite)

create/delete a routing-link between context an a service using route

Definition at line 509 of file msgque_overload_mq.h.

◆ MqRouteCreate_3

#define MqRouteCreate_3	(	ctx,
		route,
		service )

Value:

MqRouteCreate(ctx,route,service,false)

MqRouteCreate

#define MqRouteCreate(...)

Definition msgque_overload_mq.h:509

Definition at line 510 of file msgque_overload_mq.h.

◆ MqRouteCreate_C

#define MqRouteCreate_C ( ... )

Value:

if (MkErrorCheckI(MqRouteCreate(__VA_ARGS__)))

Definition at line 512 of file msgque_overload_mq.h.

◆ MqRouteCreate_E

#define MqRouteCreate_E ( ... )

Value:

MkErrorCheck(MqRouteCreate(__VA_ARGS__))

Definition at line 511 of file msgque_overload_mq.h.

◆ MqRouteCreate_NULL

#define MqRouteCreate_NULL ( ... )

Value:

MqRouteCreate_RT(MK_RT_CALL_NULL __VA_ARGS__)

MK_RT_CALL_NULL

#define MK_RT_CALL_NULL

Definition at line 508 of file msgque_overload_mq.h.

◆ MqRouteDelete

#define MqRouteDelete ( ... )

Value:

MqRouteDelete_RT(MK_RT_CALL __VA_ARGS__)

MqRouteDelete_RT

enum MkErrorE MqRouteDelete_RT(MK_RT mkrt, MQ_CTX ctx, MK_STRN route, MK_STRN service, bool overwrite)

delete a routing-link created with MqRouteCreate

Definition at line 514 of file msgque_overload_mq.h.

◆ MqRouteDelete_3

#define MqRouteDelete_3	(	ctx,
		route,
		service )

Value:

MqRouteDelete(ctx,route,service,false)

MqRouteDelete

#define MqRouteDelete(...)

Definition msgque_overload_mq.h:514

Definition at line 515 of file msgque_overload_mq.h.

◆ MqRouteDelete_C

#define MqRouteDelete_C ( ... )

Value:

if (MkErrorCheckI(MqRouteDelete(__VA_ARGS__)))

Definition at line 517 of file msgque_overload_mq.h.

◆ MqRouteDelete_E

#define MqRouteDelete_E ( ... )

Value:

MkErrorCheck(MqRouteDelete(__VA_ARGS__))

Definition at line 516 of file msgque_overload_mq.h.

◆ MqRouteDelete_NULL

#define MqRouteDelete_NULL ( ... )

Value:

MqRouteDelete_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 513 of file msgque_overload_mq.h.

◆ MqRouteGetPath

#define MqRouteGetPath ( ... )

Value:

MqRouteGetPath_RT(MK_RT_CALL __VA_ARGS__)

MqRouteGetPath_RT

enum MkErrorE MqRouteGetPath_RT(MK_RT mkrt, MQ_CTX const ctx, MK_STRN *path_out)

return the absolut route-connection-string up to the current ctx …

Definition at line 529 of file msgque_overload_mq.h.

◆ MqRouteGetPath_C

#define MqRouteGetPath_C ( ... )

Value:

if (MkErrorCheckI(MqRouteGetPath(__VA_ARGS__)))

MqRouteGetPath

#define MqRouteGetPath(...)

Definition msgque_overload_mq.h:529

Definition at line 531 of file msgque_overload_mq.h.

◆ MqRouteGetPath_E

#define MqRouteGetPath_E ( ... )

Value:

MkErrorCheck(MqRouteGetPath(__VA_ARGS__))

Definition at line 530 of file msgque_overload_mq.h.

◆ MqRouteGetPath_e

#define MqRouteGetPath_e ( ... )

Value:

MK_EMBEDDED(MK_STRN,MqRouteGetPath,__VA_ARGS__)

MK_STRN

const MK_STRB * MK_STRN

Definition at line 532 of file msgque_overload_mq.h.

◆ MqRouteGetPath_NULL

#define MqRouteGetPath_NULL ( ... )

Value:

MqRouteGetPath_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 528 of file msgque_overload_mq.h.

◆ MqRouteGetTree

#define MqRouteGetTree ( ... )

Value:

MqRouteGetTree_RT(MK_RT_CALL __VA_ARGS__)

MqRouteGetTree_RT

enum MkErrorE MqRouteGetTree_RT(MK_RT mkrt, MQ_CTX const ctx, MK_BFL *treeP_out)

create an overview about all available routing-target and services …

Definition at line 502 of file msgque_overload_mq.h.

◆ MqRouteGetTree_C

#define MqRouteGetTree_C ( ... )

Value:

if (MkErrorCheckI(MqRouteGetTree(__VA_ARGS__)))

MqRouteGetTree

#define MqRouteGetTree(...)

Definition msgque_overload_mq.h:502

Definition at line 504 of file msgque_overload_mq.h.

◆ MqRouteGetTree_E

#define MqRouteGetTree_E ( ... )

Value:

MkErrorCheck(MqRouteGetTree(__VA_ARGS__))

Definition at line 503 of file msgque_overload_mq.h.

◆ MqRouteGetTree_e

#define MqRouteGetTree_e ( ... )

Value:

MK_EMBEDDED(MK_BFL,MqRouteGetTree,__VA_ARGS__)

MkBufferListS

Definition at line 505 of file msgque_overload_mq.h.

◆ MqRouteGetTree_NULL

#define MqRouteGetTree_NULL ( ... )

Value:

MqRouteGetTree_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 501 of file msgque_overload_mq.h.

◆ MqRouteResolve

#define MqRouteResolve ( ... )

Value:

MqRouteResolve_RT(MK_RT_CALL __VA_ARGS__)

MqRouteResolve_RT

MQ_CTX_A MqRouteResolve_RT(MK_RT mkrt, MQ_CTX const ctx, MK_STRN const ident, MK_NUM const retnum)

return a list of all context belonging to ident …

Definition at line 519 of file msgque_overload_mq.h.

◆ MqRouteResolve_2

#define MqRouteResolve_2	(		ctx,
			ident )

Value:

MqRouteResolve(ctx,ident,-1)

MqRouteResolve

#define MqRouteResolve(...)

Definition msgque_overload_mq.h:519

Definition at line 520 of file msgque_overload_mq.h.

◆ MqRouteResolve_NULL

#define MqRouteResolve_NULL ( ... )

Value:

MqRouteResolve_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 518 of file msgque_overload_mq.h.

◆ MqRouteTraverse

#define MqRouteTraverse ( ... )

Value:

MqRouteTraverse_RT(MK_RT_CALL __VA_ARGS__)

MqRouteTraverse_RT

enum MkErrorE MqRouteTraverse_RT(MK_RT mkrt, MQ_CTX ctx, MK_STRN service, MK_BAC args)

traverse a tree down and call service if available.

Definition at line 522 of file msgque_overload_mq.h.

◆ MqRouteTraverse_2

#define MqRouteTraverse_2	(		ctx,
			service )

Value:

MqRouteTraverse(ctx,service,NULL)

MqRouteTraverse

#define MqRouteTraverse(...)

Definition msgque_overload_mq.h:522

Definition at line 523 of file msgque_overload_mq.h.

◆ MqRouteTraverse_C

#define MqRouteTraverse_C ( ... )

Value:

if (MkErrorCheckI(MqRouteTraverse(__VA_ARGS__)))

Definition at line 525 of file msgque_overload_mq.h.

◆ MqRouteTraverse_E

#define MqRouteTraverse_E ( ... )

Value:

MkErrorCheck(MqRouteTraverse(__VA_ARGS__))

Definition at line 524 of file msgque_overload_mq.h.

◆ MqRouteTraverse_NULL

#define MqRouteTraverse_NULL ( ... )

Value:

MqRouteTraverse_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 521 of file msgque_overload_mq.h.

Function Documentation

◆ MqRouteCreate_RT()

enum MkErrorE MqRouteCreate_RT	(	MK_RT	mkrt,
		MQ_CTX	ctx,
		MK_STRN	route,
		MK_STRN	service,
		bool	overwrite )

create/delete a routing-link between context an a service using route

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]	route	the absolute or relative path to the target-context, if NULL or '\0' the current context is returned.
[in]	service	the service token on the target context
[in]	overwrite	if `overwrite=false` an error is raised if the service already exists.

Returns: The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk

See also: MqRouteCreate, MqRouteDelete

◆ MqRouteDelete_RT()

enum MkErrorE MqRouteDelete_RT	(	MK_RT	mkrt,
		MQ_CTX	ctx,
		MK_STRN	route,
		MK_STRN	service,
		bool	overwrite )

delete a routing-link created with MqRouteCreate

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]	route	the absolute or relative path to the target-context, if NULL or '\0' the current context is returned.
[in]	service	the service token on the target context
[in]	overwrite	if `overwrite=false` an error is raised if the service already exists.

Returns: The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk

See also: MqRouteCreate, MqRouteDelete

◆ MqRouteGetPath_RT()

enum MkErrorE MqRouteGetPath_RT	(	MK_RT	mkrt,
		MQ_CTX const	ctx,
		MK_STRN *	path_out )

return the absolut route-connection-string up to the current ctx …

The absolut route-connection-string is the route starting at root (e.g. "/").

Attention

The path_out returned is owned by the loopback-slave -> do not free.
The path_out returned is only valid until the next call to the loopback-slave.

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
[out]	path_out	the return path or `MK_NULL` on error

Returns: The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk

See also: MqRouteGetTree

◆ MqRouteGetTree_RT()

enum MkErrorE MqRouteGetTree_RT	(	MK_RT	mkrt,
		MQ_CTX const	ctx,
		MK_BFL *	treeP_out )

create an overview about all available routing-target and services …

The data returned is a list of "ROUTE|IDENT|SERVICE,..." string items.

The ROUTE is the route-connection-string used in (runtime) enum MkErrorE MqRouteCreate(MQ_CTX ctx, MK_STRN route, MK_STRN service, MK_BOOL overwrite).
The IDENT is the MqClassIdentGet and usually the final part of the route-connection-string.
The SERVICE is the list of services available at IDENT.

Example from MyWorker.c → get the "Tree" as service

    void TREE () {
      Send("R", "L", RouteGetTree());
    }

Example from tests/route2.test -> route2-1-0

Get a list of all services on all servers reachable by test-context.

 /cl-0/sv-0/svWO2-11/svWO3-11|svWO3-11-0-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-11/svWO3-11|svWO3-11-1-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-11/svWO3-11|svWO3-11-2-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-11/svWO3-12|svWO3-12-0-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-11/svWO3-12|svWO3-12-1-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-11/svWO3-12|svWO3-12-2-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-11|svWO2-11-0-2|FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-11|svWO2-11-1-2|FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-11|svWO2-11-2-2|FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-12/svWO3-11|svWO3-11-0-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-12/svWO3-11|svWO3-11-1-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-12/svWO3-11|svWO3-11-2-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-12/svWO3-12|svWO3-12-0-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-12/svWO3-12|svWO3-12-1-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-12/svWO3-12|svWO3-12-2-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-12|svWO2-12-0-2|FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-12|svWO2-12-1-2|FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-12|svWO2-12-2-2|FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0|sv-0-0-2|FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0|sv-0-1-2|FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0|sv-0-2-2|FOID,HLWO,HLWS,PATH,TREE
 /cl-0|cl-0-0-2|HLWO,HLWS
 /cl-0|cl-0-1-2|HLWO,HLWS
 /cl-0|cl-0-2-2|HLWO,HLWS
 /cl-0/sv-0/svWO2-11/svWO3-11|svWO3-11-0-2|FINL,FOID,HLWO,HLWS,PATH,TREE
 /cl-0/sv-0/svWO2-11/svWO3-11|svWO3-11-1-2|FINL,FOID,HLWO,HLWS,PATH,TREE

The following information is available:

root is cl-0
multiple other clients, parallel to cl-0, are reachable: cl-0-....
multiple servers involved: sv...
multiple services reachable: FINL,FOID,HLWO,HLWS,PATH,TREE

Attention

The list-object returned is owned by MqRouteGetTree and is only valid until the next call to MqRouteGetTree.
On error the list-object will be empty.

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
[out]	treeP_out	the tree-object with the results…

Returns: The MkErrorE status from the DEFAULT MkErrorC in MkRuntimeS::error_mk

See also: MqRouteGetPath

◆ MqRouteResolve_RT()

MQ_CTX_A MqRouteResolve_RT	(	MK_RT	mkrt,
		MQ_CTX const	ctx,
		MK_STRN const	ident,
		MK_NUM const	retnum )

return a list of all context belonging to ident …

This api-proc is used to return all context with MqLinkS::targetIdent == ident .

The MqLinkS::targetIdent is the value returned by MqClassIdentGet from the remote-context based on the configuration value of --ident-from prefix|factory.
The MqConfigS::dispPrefix is initialized with MqFactoryS::originalIdent and can be modified with MqConfigSetPrefix.
The MqFactoryS::originalIdent is set by MqFactoryAdd at factory setup.

In addition the following special ident are recognized:

EMPTY or MK_NULL or DOT=. or ClassIdentGet -> The loopback-slave
DOUBLE-DOT=.. -> On the server the server-context and on the slave the master-context

Example from server.c → in a service call return all connected targets

    MK_STRN rmtIdent = MqReadSTR_e (mqctx);
    for (MQ_CTX* ret=MqRouteResolve(mqctx,rmtIdent,-1).data; *ret != NULL; ret++) {
      MqSendSTR_E (mqctx, MqLinkGetTargetIdent(*ret));
    }

See also: MqRouteTraverse

Attention: 1. (do not free) The memory of the out/return value belongs to the called libmqmsgque function and therefore never becomes MK_NULL for a non-error result.
For details on the out/return value, see: MkKernel_Storage_C_API.
2. The maximun number of items in the return-array is MQ_ROUTE_CTX_MAX .
3. (C-API) The last item in the return-array is always a MK_NULL.

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]	ident	The identifer to search the context for
[in]	retnum	The maximum number-of-items accepted in the result-array, if `<0` than MQ_ROUTE_CTX_MAX is used.

Returns: An array of MqContextC, the last item is a MK_NULL.

◆ MqRouteTraverse_RT()

enum MkErrorE MqRouteTraverse_RT	(	MK_RT	mkrt,
		MQ_CTX	ctx,
		MK_STRN	service,
		MK_BAC	args )

traverse a tree down and call service if available.

The MqRouteTraverse is intended to call a service on all-routes "*" starting from ctx.

This is a tool to be used to do maintenance work, sometimes a service is changed (e.g MqRouteCreate) or an internal status need to be reset.

Note: - Internal the service is called using the loopback-slave context, be aware to call MqSlaveGetMaster first to start on the master-context.; - It is not an error if a service does not exists on a specific route starting from ctx.

The following internal tasks are performed ( C notation ) :

Call MqSendEND_AND_WAIT on the MQ_SLAVE_LOOPBACK if the service exists.
if (MqServiceTokenExists(ctx,service)) {

MQ_CTX loop = MqSlaveGet_e(ctx,MQ_SLAVE_LOOPBACK);

MqSendSTART_E(loop);

MqSendL_FLAT_E(loop,args);

MqSendEND_AND_WAIT_E(loop,service,MK_TIMEOUT_DEFAULT);

}
Call MqRouteResolve with "*" to get all routes starting from the ctx up to MQ_ROUTE_CTX_MAX routes :
int flag[MQ_ROUTE_CTX_MAX] = {0};

MQ_CTX_A rr = MqRouteResolve(ctx, "*", -1);
Call MqRouteTraverse on every route from rr with :
// call for a "routing" setup/check using all rrctx from "rr->list" in parallel.

// -> use "flag" to check if a callback was called.

for (int i=0; i<rr.size; i++) {

MQ_CTX rrctx = rr.data[i];

if (MQ_IS_LOOPBACK(rrctx)) continue;

if (MQ_IS_SERVER(rrctx) && ctx == rrctx) continue;

MqSendSTART_E(rrctx);

MqSendSTR_E(rrctx,service);

MqSendBFL_E(rrctx,args);

if (MkErrorCheckI(MqSendEND_AND_CALLBACK(rrctx,"_RTR",sRouteTool_CB,&flag[i],NULL,MK_TIMEOUT_DEFAULT))) {

pContextErrorCopy ( ctx,rrctx);

goto error;

}

}

The sRouteTool_CB set the flag[i] to 1 to signal done.
Call MqProcessEvent to wait for an answer and check on error with timeout MK_TIMEOUT_DEFAULT.
// wait to finish all "calls" from obove - using "flag" to check if wait is still required.

for (int i=0; i<rr.size; i++) {

MQ_CTX rrctx = rr.data[i];

if (MQ_IS_LOOPBACK(rrctx)) continue;

if (MQ_IS_SERVER(rrctx) && ctx == rrctx) continue;

while (flag[i] == 0) { // just be shure the CB is still "open=0"

if (MkErrorCheckI(MqProcessEvent(rrctx, MQ_WAIT_OWN, MK_TIMEOUT_DEFAULT))) {

MqContextErrorCopy (ctx,rrctx);

goto error;

}

}

}

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]	service	the service token to be called
[in]	args	command-line-arguments passed as arguments to the service call

Macros

Functions

MqContextC - MqContextC_RouteApi_Route_C_API - overload

Detailed Description

TCP/IP layer model

LibMqMsgque layer model

example (C++ syntax)

Macro Definition Documentation

◆ MQ_ROUTE_CTX_MAX

◆ MqRouteCreate

◆ MqRouteCreate_3

◆ MqRouteCreate_C

◆ MqRouteCreate_E

◆ MqRouteCreate_NULL

◆ MqRouteDelete

◆ MqRouteDelete_3

◆ MqRouteDelete_C

◆ MqRouteDelete_E

◆ MqRouteDelete_NULL

◆ MqRouteGetPath

◆ MqRouteGetPath_C

◆ MqRouteGetPath_E

◆ MqRouteGetPath_e

◆ MqRouteGetPath_NULL

◆ MqRouteGetTree

◆ MqRouteGetTree_C

◆ MqRouteGetTree_E

◆ MqRouteGetTree_e

◆ MqRouteGetTree_NULL

◆ MqRouteResolve

◆ MqRouteResolve_2

◆ MqRouteResolve_NULL

◆ MqRouteTraverse

◆ MqRouteTraverse_2

◆ MqRouteTraverse_C

◆ MqRouteTraverse_E

◆ MqRouteTraverse_NULL

Function Documentation

◆ MqRouteCreate_RT()

◆ MqRouteDelete_RT()

◆ MqRouteGetPath_RT()

◆ MqRouteGetTree_RT()

◆ MqRouteResolve_RT()

◆ MqRouteTraverse_RT()