zmq-prebuilt
Users | Contributors and Development | Maintainers
zmq-prebuilt: Your ready to use, prebuilt ØMQ bindings for Node.js.
ØMQ provides handy functionality when working with sockets. Yet, installing dependencies on your operating system or building ØMQ from source can lead to developer frustration.
zmq-prebuilt simplifies creating communications for a Node.js application by providing well-tested, ready to use ØMQ bindings. zmq-prebuilt supports all major operating systems, including:
- OS X/Darwin 64-bit
- Linux 64-bit
- Windows (64-bit and 32-bit)
Use zmq-prebuilt and take advantage of the elegant simplicity of binaries.
Installation - Users
Prerequisites
We rely on prebuild
.
Install zmq-prebuilt
with the following:
npm install zmq-prebuilt
Now, prepare to be amazed by the wonders of binaries.
Usage
Replace require(zmq)
in your code base with require(zmq-prebuilt)
. That's it.
The wonder of binaries begins.
Installation - Contributors and Development
To set up zmq-prebuilt
for development, fork this repository and
clone your fork to your system. Be sure you have git-lfs
installed.
Prerequisites for Linux
python
(v2.7
recommended,v3.x.x
is not supported)make
- A proper C/C++ compiler toolchain, like GCC
Use your distribution's package manager to install.
Prerequisites for macOS
python
(v2.7
recommended,v3.x.x
is not supported): already installed on Mac OS XXcode Command Line Tools
: Can be installed withxcode-select --install
Prerequisites for Windows
-
Option 1: Install all the required tools and configurations using Microsoft's windows-build-tools by running
npm install -g windows-build-tools
from an elevated PowerShell (run as Administrator). -
Option 2: Install dependencies and configuration manually
- Visual C++ Build Environment:
- Option 1: Install Visual C++ Build Tools using the Default Install option.
- Option 2: Install Visual Studio 2015 (or modify an existing installation) and select Common Tools for Visual C++ during setup.
💡 [Windows Vista / 7 only] requires .NET Framework 4.5.1
- Install Python 2.7 or Miniconda 2.7 (
v3.x.x
is not supported), and runnpm config set python python2.7
- Launch cmd,
npm config set msvs_version 2015
Installation
Install a development version of zmq-prebuilt
with the following:
npm install
Testing
Run the test suite using:
npm test
Running an example application
Several example applications are found in the examples
directory. Use
node
to run an example. To run the 'subber' application, enter the
following:
node examples/subber.js
Examples using zmq-prebuilt
Push/Pull
This example demonstrates how a producer pushes information onto a socket and how a worker pulls information from the socket.
producer.js
// producer.jsvar zmq = sock = zmq; sock;console; ;
worker.js
// worker.jsvar zmq = sock = zmq; sock;console; sock;
Pub/Sub
This example demonstrates using zmq-prebuilt
in a classic Pub/Sub,
Publisher/Subscriber, application.
Publisher: pubber.js
// pubber.jsvar zmq = sock = zmq; sock;console; ;
Subscriber: subber.js
// subber.jsvar zmq = sock = zmq; sock;sock;console; sock;
For maintainers: Creating a release
When making a release, do the following:
npm version minor && git push && git push --tags
Then, wait for the prebuilds to get uploaded for each OS. After the prebuilds are uploaded, run the following to publish the release:
npm publish
To check if the binaries are packaged correctly, you can push a commit to
nteract/zmq-prebuilt-testing
.
Learn more about nteract
- Visit our website http://nteract.io/.
- See our organization on GitHub https://github.com/nteract
- Join us on Slack if you need help or have questions. If you have trouble creating an account, either email rgbkrk@gmail.com or post an issue on GitHub.
