Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

tiny-zmq

2.0.1 • Public • Published

TinyZMQ

Tiny ZMQ is an NodeJS package that provides simple, load balanced and resilient messaging on distributed environments.

It implements the Client - Broker - Worker schema and takes care of reachability. The stock ZMQ implementation for NodeJS may run into issues if some of the workers get offline.

An example Docker container is also provided, for convenience.

Installation

Install it from NPM

npm i -S tiny-zmq

Note: You need to have libzmq installed in your computer in order to install the dependencies (zmq).

TinyZMQ implements two communication patterns: Work balancing (ventilator) and Data Broadcast.

Work balancing

Follow this pattern if you have many nodes requesting operations, several workers and need a central broker to do load balancing.

Broker

Create a component that acts as the broker:

const broker = require('tiny-zmq').balancing.broker;

broker.bind({
	clientsPort: 5559,
	workersPort: 5560
});

Client

To register a client, add this code to the component that places requests:

const client = require('tiny-zmq').balancing.client;

const sendRequest = client.connect('tcp://localhost:5559');

sendRequest({ number: 1234 }, function(response){
	console.log("THE CLIENT GOT BACK:", response);
});

Worker

To register a worker, add this code to the component accepting work requests:

const worker = require('tiny-zmq').balancing.worker;

worker.connect('tcp://localhost:5560', function(parameters, doneCallback){
	console.log("THE WORKER GOT", parameters);

	const result = doProcessing(parameters);
	doneCallback(result);
});

function doProcessing(parameters){
	parameters.value = Math.random(); // just appends a random number
	return parameters;
}

Data broadcast

Follow this pattern if you have many nodes generating events, many nodes that need to be notified of them and a central broker to broadcast the data.

Broker

Create a component that acts as the broker:

const broker = require('tiny-zmq').broadcast.broker;

broker.bind({
	clientsPort: 5559,
	subscribersPort: 5560
});

Client

To register a client, add this code to the component that places requests:

const client = require('tiny-zmq').broadcast.client;

const sendRequest = client.connect("tcp://localhost:5559");

var i = 0;
setInterval(function(){
	var request = { number: ++i, pid: process.pid };

	console.log("THE CLIENT NOTIFIES", request);

	sendRequest(request);
}, 2000);

Subscriber

To register a subscriber, add this code to the component:

const worker = require('tiny-zmq').broadcast.subscriber;

worker.connect("tcp://localhost:5560", function(payload){
	console.log("THE SUBSCRIBER GOT", payload);

	// HANDLE THE NOTIFICATION HERE
});

Parameterization

The internal behavior can be tuned by using environment variables at run time.

  • TINY_ZMQ_DEBUG: By default, disabled when NODE_ENV='production' and true otherwise. When set to true, provides extra logging information.
  • TINY_ZMQ_PING_BASE_INTERVAL: The client will periodically ping the worker to assert that it is still alive. By default, every 500 milliseconds.
  • TINY_ZMQ_INACTIVITY_TIMEOUT: After no pingback response from either the client or the worker, the connection will be retried again. By default, the timeout is 5000 milliseconds.
  • TINY_ZMQ_CLIENT_INSTANCES: The number of client instances running on the environment. This helps to better adjust the actual rate of pings between nodes.
  • TINY_ZMQ_WORKER_INSTANCES: The number of worker instances running on the environment.

Utilities

To get an example of a container running the broker, worker or client on a Linux + NodeJS + ZMQ environment, refer to the Dockerfile.

To build a test image for each component, run the appropriate command from the project folder:

docker build --build-arg target=broker -t img_broker .
docker build --build-arg target=worker -t img_worker .
docker build --build-arg target=client -t img_client .

Once the images are built, you can run them inside a container:

docker run -it --name my_broker img_broker
docker run -it --name my_worker img_worker
docker run -it --name my_client img_client

Note: By default, the broker IP is assumed to be 172.17.0.2. To change it, add a build argument:

docker build --build-arg target=worker --build-arg broker_ip=172.17.0.5 -t img_worker .

docker build --build-arg target=client --build-arg broker_ip=172.17.0.5 -t img_client .

Related


by Jordi Moraleda - Tvrbo

Install

npm i tiny-zmq

DownloadsWeekly Downloads

0

Version

2.0.1

License

ISC

Last publish

Collaborators

  • avatar