signal-server

0.0.2 • Public • Published

signal-server

This is a simple UDP server for local event-driven "IPC". It will be installed as a service in your system.

Warning: This was only tested in Windows 10.

Warning: This IS NOT production ready.

Obs.: For commands, be sure to use an elevated console (admin rights).

Prerequisites

  • You MUST be running Windows 10 or Linux (untested).
  • You MUST have up to date Node JS installed.
  • You MUST have up to date NPM installed.
  • If running Windows 10, you must run the following command: npm install --global --production windows-build-tools. Obs.: It may fail sometimes.
  • If running Windows 10, you must ensure Phyton 2.7 (installed in the previous item) is in your Path.

Usage

Step 1

Install the server as a service with the following comands:

npm install -g signal-server
signal-service install my-test 8888
Step 2
  • On Windows, start the server running: net start signal-my-test on elevated shell.
  • On Debian/Ubuntu, start the server running: sudo service signal-my-test start.
Step 3

The first character in the UDP message will be interpreted as a command of the following three.

  • w: For watching the specified event.
  • u: For unwatching the specified event.
  • f: For firing the specified event.

With any UDP client of your preference, send one of the following messages to 8888:

  • wCoolEvent: For subscribing to our "Cool Event".
  • fCoolEvent: For firing our Cool Event (and be notified about it, receiving a message CoolEvent).
  • uCoolEvent: For unsubscribing to our "Cool Event".

Have Questions?

Please, if you have any questions, suggestions, doubts, etc.. Don't hesitate to open issues.

Thanks!

Package Sidebar

Install

npm i signal-server

Weekly Downloads

0

Version

0.0.2

License

ISC

Unpacked Size

5.2 kB

Total Files

4

Last publish

Collaborators

  • gcsboss