package
Metroplex is capable of transforming into a battle station, giant robot or a distributed connect client directory for Primus.
npm install metroplexGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Metroplex a Redis based spark/connection registry for Primus.
Metroplex is released in the npm registry and can therefor be installed using:
npm install --save metroplexOnce you've installed the module you need to tell Primus to use the plugin which
is done using the primus.plugin method:
'use strict';
var http = require('http').createServer()
, Primus = require('primus')
, primus = new Primus(http, { transformer: 'sockjs' });
primus.plugin('metroplex', require('metroplex'));In the example above you've seen how to add the plugin to your Primus server but not how to configure it. We have various of options that can be configured in this plugin:
ioredis client.metroplex.300000 msalive key in Redis.
This time is subtracted from the set interval so we update the key BEFORE
it expires. Defaults to 2000 ms.http://0.0.0.0:8080 from
it.These options should be provided in the options object of the Primus server:
primus = new Primus(http, {
transformer: 'sockjs',
namespace: 'metroplex',
redis: require('redis').createClient()
});
primus.plugin('metroplex', require('metroplex'));The orchestration is all done using the metroplex library which is bundled in
this plugin. The Metroplex instance is exposed on the Primus instance when you
use this plugin:
primus.metroplex.servers(function (err, servers) {
console.log('registered servers:', servers);
});The following public methods are available.
metroplex.servers(fn)List all the servers in our current registry.
metroplex.servers(function (err, servers) {
console.log(servers);
});metroplex.spark(id, fn)Get the server for the given spark id. It does not check if the spark is hosted on the current server. That's up to the developer to implement.
metroplex.spark(id, function (err, server) {
console.log(server);
});metroplex.sparks(sparks, fn)Get the servers for each id in the given sparks array. It will return an
object and just like metroplex.spark it does not check if the spark is hosted
on the current server.
If you load the omega-supreme
plugin before metroplex, you can use some additional convenience methods.
These methods are added to the primus.forward object:
forward.broadcast(msg, fn)Broadcast a message to all sparks in the cluster.
forward.broadcast('data', function (err, result) {
// result is an object with details about the result of the operation.
console.log(result);
});forward.sparks(ids, msg, fn)Send a message to a set of sparks in the cluster.
forward.sparks(['ad8a-280z-18', 'y97x-42480-13'], 'data', function (err, result) {
console.log(result);
});forward.spark(id, msg, fn)Send a message to a single spark in the cluster.
forward.spark('ad8a-280z-18', 'data', function (err, result) {
console.log(result);
});
lpinca
luigipinca@gmail.com
Estimated unpacked size across 16 packages.
2.3 MB
Includes dependencies.
5 direct · 3 outdated
^1.1.4
2.0.1
^3.2.0
3.2.6
^1.0.0
1.0.0
^4.17.0
6.0.0
^4.0.0
5.0.4