Caché Publisher - Subscriber

The purpose of this repository is to provide a simple example of Publisher-Subscriber model implemented using InterSystems Caché.

This example came out of a session which discussed ways of processing work asynchronously using persistent queues.

Installation

set path="C:\Temp\cache-iat-pubsub-master\cache"
do $system.OBJ.ImportDir(path,"*.inc","ck",.error,1)
do $system.OBJ.ImportDir(path,"*.xml","ck",.error,1)

Run the code

; create events and subscriber jobs
do ##class(IAT.PubSub.Example.Main).Setup()
; send some messages to channels
do ##class(IAT.PubSub.Example.Main).Run()
; show log
zwrite ^PubSub.Log
hang 10
zwrite ^PubSub.Log
hang 10
zwrite ^PubSub.Log
; stop demo
hang 10
do ##class(IAT.PubSub.Manager).TerminateAll()
; show log
zwrite ^PubSub.Log
;  

Implementation

Caché Event API is used to let the subscriber processes sleep until they are notified.

Main classes

• Manager - handles core operations such as adding subscribers, terminate all subscriber jobs, etc.
• Publisher - generic publisher, provides a basic Send operation which notifies a subscriber that a message is ready.
• Subscriber - generic subscriber, all subscriber must extend from this.

Example classes

The following classes provides an example of how the main classes could be used, in this case there are two subscribers:

• SubPatient which handles Patient related messages.
• SubDummy which handles dummy messages.

Log

After running the example, the log stored in ^PubSub.Log global will look similar to this:

Further discussion

There are several points of this example that can be discussed as an exercise:

Caché Event API vs Semaphores

• $system.Event (Caché Event API) can only wait / wake up resources on the same system (not networking supported).
• It would be interesting implementing this same model using $system.Semaphore over an ECP scenario.

Multiple types of subscribers

• In IAT.PubSub.Publisher:Send() method, it simply creates a message header, save it to queue and send a signal to one of the subscribers.
• It would be interesting allowing more than one type of subscriber per channel. In this case, the Send() method should create several message headers and signal the different types of configured subscribers.

Developer Community

Have a look at InterSystems Developer Community to learn about InterSystems technology, sharing solutions and staying up-to-date on the latest developments.

This example was published in https://community.intersystems.com/post/simple-systemevent-examples

Docker

Container build and start runs ALL installation steps.
It is immedeatly ready for use as described

Prerequisites

Make sure you have git and Docker desktop installed.

Installation

Clone/git pull the repo into any local directory

$ git clone https://github.com/rcemper/PR_iat-pubsub.git

$ docker compose up -d && docker compose logs -f

Quick REST access to MASTER:
http://localhost:42773/synchmaster/rest/v1/customers

Quick REST access to CLIENT:
http://localhost:42773/synchclient/rest/v1/employees

To open IRIS Terminal do:

$ docker-compose exec iris iris session iris 
USER>

or using WebTerminal
http://localhost:42773/terminal/

To access IRIS System Management Portal
http://localhost:42773/csp/sys/UtilHome.csp