Known for his great strength and greater courage, Omega Supreme is the Autobots’ last line of defense against the Decepticons
Known for his great strength and greater courage, Omega Supreme is the Autobots’ last line of defense against the Decepticons. He will stand unwaveringly against overwhelming odds, and although outwardly grim, he is known by those with enough insight to actually relish the importance of his task – Omega knows that if he falls, it is unlikely there will be any remaining Autobots to take his place, but he would not have it any other way.
In Primus mode, Omega Supreme has an incredible configurability, is able to broadcast a message with a single request and can distribute messages to single sparks. In place of his left hand, he is armed with authentication which can pulverize any attacker.
Or in plain English,
omega-supreme allows you to broadcast messages to
Primus using a regular HTTP request. These messages can be broadcasted to every
single connection on the server, a single spark or an array of sparks. This
allows other languages to easily write messages to your server without the need
of creating a complex architecture.
npm install --save omega-supreme
Omega Supreme should be added as a plugin in Primus. The plugin will also add
omega-supreme middleware which will intercept the incoming HTTP requests and
will take care of the actual distribution of the message to every single connected
client. Adding plugins in Primus is done using the
.plugin(name, plugin) method.
The options for the plugin can directly be added to the constructor of your Primus
server so all the configuration of the server and the plugins is in one central
location as illustrated in the example below:
'use strict';var Primus =server = ;var primus = server/* Add the options here, in the Primus's options */;primus;server;
There are various options available, they are all optional but we highly
recommend to change the
username options to something unique.
User name and password are used to authenticate the HTTP requests containing the
information to bradcast. The following options can be configured:
Now that you've added the
omega-supreme plugin to your Primus server you can
communicate/broadcast with it using plain HTTP requests. We make a couple
assumptions to the data that is sent to the server:
msgProperty contains the data that needs to be sent to the connections.
sparksProperty can be an array of spark ids or a string which is the spark id. If no
sparksproperty is supplied we assume that the given message needs to be broadcasted to every single connection on this server.
When your message has been successfully processed by the server it returns a JSON object with some information:
ok: truesend: 10
send property indicates the amount of connections we've written the
message payload to. If your request has failed a 500 or 401 status code will be
set and a slightly different JSON object will be returned:
ok: falsereason: 'invalid data structure'
In order to make the messaging even easier to use,
omega-supreme adds a
primus.forward method to your Primus server instance. It allows you to broadcast
messages to the supplied server. It will only write the message to the supplied
server if the supplied sparks are not on the current server.
Sending a message to a spark on a different server:
Sending to a group of sparks:
Or just broadcasting by not supplying the optional sparks argument:
In all the examples above, we've sent an
event packet. If you're using
primus-emit and you want to trigger
custom events you should use this format:
Keep in mind that you don't have to write event blobs, you can write anything you want.