zmq - npm Package Compare versions

Comparing version 1.0.4 to 2.0.0

package.json

 {
-    "name": "zmq",
-    "version": "1.0.4",
-    "description": "Bindings for node.js to zeromq",
-    "main": "zmq",
-    "repository": {
-        "type" : "git",
-        "url" : "http://github.com/JustinTulloss/zeromq.node.git"
-    },
-    "engines": {
-        "node": ">=0.3.0"
-    },
-    "contributors": [
-        "Justin Tulloss <[e-mail]> (http://justin.harmonize.fm)",
-        "Stéphan Kochen <[e-mail]> (http://stephan.kochen.nl/)",
-        "Mike Castleman <[e-mail]> (http://mlcastle.net/)",
-        "Matt Crocker",
-        "Jeremy Barnes <[e-mail]> (http://www.barneso.com/)",
-        "Rick <[e-mail]> (http://techno-weenie.net/)",
-        "Corey Jewett (http://syntheticplayground.com/)",
-        "Micheil Smith <[e-mail]> (http://brandedcode.com/)"
-    ]
+  "name": "zmq",
+  "version": "2.0.0",
+  "description": "Bindings for node.js to zeromq",
+  "main": "index",
+  "repository": {
+    "type" : "git",
+    "url" : "http://github.com/JustinTulloss/zeromq.node.git"
+  },
+  "devDependencies": {
+    "should": "0.3.1"
+  },
+  "engines": {
+    "node": ">=0.3.0 <0.7.0"
+  },
+  "contributors": [
+    "Justin Tulloss <[e-mail]> (http://justin.harmonize.fm)",
+    "Stéphan Kochen <[e-mail]> (http://stephan.kochen.nl/)",
+    "Mike Castleman <[e-mail]> (http://mlcastle.net/)",
+    "Matt Crocker",
+    "Jeremy Barnes <[e-mail]> (http://www.barneso.com/)",
+    "Rick <[e-mail]> (http://techno-weenie.net/)",
+    "Corey Jewett (http://syntheticplayground.com/)",
+    "Micheil Smith <[e-mail]> (http://brandedcode.com/)",
+    "TJ Holowaychuk <[e-mail]> (http://tjholowaychuk.com/)"
+  ]
 }

README.md

@@ -1,146 +0,55 @@
-This library gives you bindings to ØMQ from node.js. This is not terribly
-well tested, but there is at least one company successfully using these bindings
-in production. Bug reports welcome.
 
-To Install
-==========
+# node-zeromq
 
-First, get [ØMQ 2.1], [Homebrew] on Mac will get you what you need.
-Debian/Ubuntu users may also need to install the `libev-dev` package.
+  ØMQ bindings for node.js
 
-Then use [npm] to install zeromq.node:
+## Installation
 
     $ npm install zmq
 
-`npm` will yell at you if you don't have node 0.3.0, as that is required.
+## Example
 
-API
-===
+producer.js:
 
-The API contains elements of the [ØMQ API]. You should refer to it
-for in depth detail of the expected behaviors of the system. These methods will
-never return error codes, but may throw an exception if any of the errors
-described in the ØMQ documentation occur.
+```js
+var zmq = require('zeromq')
+  , sock = zmq.socket('push');
 
-First, include the module:
+sock.bindSync('tcp://127.0.0.1:3000');
+console.log('Producer bound to port 3000');
 
-    zmq = require('zmq');
+setInterval(function(){
+  console.log('sending work');
+  sock.send('some work');
+}, 500);
+```
 
-After that, you can create sockets with:
+worker.js:
 
-    socket = zmq.createSocket('req');
+```js
 
-Using ØMQ sockets
------------------
-A socket is where the action happens. You can send and receive things and it is
-oh such fun.
+var zmq = require('zeromq')
+  , sock = zmq.socket('pull');
 
-#### Constructor - `function(type)`
+sock.connect('tcp://127.0.0.1:3000');
+console.log('Worker connected to port 3000');
 
- * type - A string describing the type of socket. You can read about the
-   different socket types [here][zmq_socket]. The name you use here matches the
-   names of the `ZMQ_*` constants, sans the `ZMQ_` prefix.
+sock.on('message', function(msg){
+  console.log('work: %s', msg.toString());
+});
+```
 
-#### Methods
+## Running tests
 
- * connect(address) - Connect to another socket. `address` should be a string
-   as described in the [ØMQ API docs][zmq_connect]. This method is not
-   asynchronous because it is non-blocking. ØMQ will use the provided address
-   when it's necessary and will not block here.
+  Install dev deps:
 
- * bind(address, callback) - Bind to a socket to wait for incoming data.
-   `address` should be a string as described in the [ØMQ API docs][zmq_bind].
-   `callback` will be called when binding is complete and takes one argument,
-   which may be an `Error`, or simply `undefined` if everything's peachy.
+     $ npm install
 
- * send(message, ...) - `message` is a string to send across the wire. The
-   message is not sent immediately, but there is no callback indicating when
-   it has been transmitted. See the
-   [0MQ](http://www.zeromq.org/intro:read-the-manual) documentation for
-   [zmq_send](http://api.zeromq.org/2-1:zmq-send) for exact
-   transmission semantics. Raises an exception if the return is < 0.
+  Build:
 
-   The message must be a `Buffer` object or a string. It is assumed that
-   strings should be transmitted as UTF-8. If you provide more than one
-   argument to send, then a multipart ØMQ message will be sent.
+     $ make
 
- * close() - Closes the socket
+  Test:
 
-#### Socket Options
+     $ make test
 
-   To set a socket option on a socket, use socket[property].  For example,
-
-   socket['identity'] = "mainLoop";
-
-   The following properties are available (the ZMQ_XXX constant describes the name in the ZeroMQ documentation available at [ØMQ setsockopt API]):
-
-   * ioThreadAffinity - set affinity for IO thread (integer, ZMQ_AFFINITY);
-   * backlog - set connection backlog for listening sockets (integer, ZMQ_BACKLOG);
-   * identity - set the socket identity (name) (string, ZMQ_IDENTITY);
-   * lingerPeriod - set the linger period in milliseconds (integer, -1 = unlimited, ZMQ_LINGER);
-   * receiveBufferSize - set the kernel receive buffer size (integer, 0 = OS default, ZMQ_RCVBUF);
-   * sendBufferSize - set the kernel receive buffer size (integer, 0 = OS default, ZMQ_RCVBUF);
-
-   The following apply to message buffering and reconnection:
-
-   * reconnectionInterval - set the time to wait between reconnection attempts in milliseconds (ZeroMQ attempts to reconnect broken connection automatically behind the scenes) (integer, ZMQ_RECONNECT_IVL)
-   * highWaterMark - set high water mark (in number of outstanding messages) before buffered messages start being dropped or swapped to disk (integer, zero = unlimited, ZMQ_HWM);
-   * diskOffloadSize - set the amount of disk swap space in bytes for buffering messages in case of disconnection (integer, ZMQ_SWAP)
-
-   The following options are applicable to multicast:
-
-   * multicastLoop - set whether multicast can go over loopback or not (boolean, ZMQ_MCAST_LOOP);
-   * multicastDataRate - set maximum multicast transmission rate in kbits per second (integer, ZMQ_RATE);
-   * multicastRecovery - set maximum multicast recovery interval in seconds (integer, ZMQ_RECOVERY_IVL)
-
-   The following properties are exposed but not normally used by client code (they are used internally by the library):
-
-   * _fd - File descriptor (integer, ZMQ_FD);
-   * _ioevents - Event loop used internally (ZMQ_EVENTS);
-   * _receiveMore - Message has more parts (boolean, ZMQ_RCVMORE);
-   * _subscribe - Subscribe to a channel (see subscribe() method) (string, ZMQ_SUBSCRIBE);
-   * _unsubscribe - Unsubscribe to a channel (see unsubscribe() method) (string, ZMQ_UNSUBSCRIBE);
-
-
-#### Events
-
- * message - A message was received. The arguments are the parts of the
-   message. So, for example, if you have an `xrep` socket with plain `req`
-   sockets on the other end, you can do something like:
-
-       socket.on('message', function(envelope, blank, data) {
-         socket.send(envelope, blank, compute_reply_for(data));
-       });
-
- * error - There was some error. The only argument is an `Error` object
-   explaining what the error was.
-
-
-To Build
-========
-
-     $ node-waf configure build
-
-Testing
-=======
-
-Tests are pretty incomplete right now, but to run what's there:
-
-    $ npm install vows
-    $ vows
-
-Licensing
-=========
-
-Licensed under the very permissive [MIT License].
-
-[node.js]: http://github.com/ry/node
-[npm]: https://github.com/isaacs/npm
-[ØMQ 2.1]: http://www.zeromq.org/intro:get-the-software
-[Homebrew]: http://mxcl.github.com/homebrew/
-[ØMQ API]: http://api.zeromq.org/
-[ØMQ setsockopt API]: http://api.zeromq.org/2-1-3:zmq-setsockopt
-[zmq_socket]: http://api.zeromq.org/zmq_socket.html
-[zmq_connect]: http://api.zeromq.org/zmq_connect.html
-[zmq_bind]: http://api.zeromq.org/zmq_bind.html
-[MIT license]: http://www.opensource.org/licenses/mit-license.php

test/test.js

 var vows = require('vows'),
     assert = require('assert'),
-    zeromq = require('../zeromq');
+    zeromq = require('../');
 
@@ -5,0 +5,0 @@ var suite = vows.describe('ZeroMQ');

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 3 instances in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

288472

increased by209.28%

Number of package files

40

increased by100%

Lines of code

1586

increased by193.16%

Number of medium supply chain risk alerts

4

decreased by-20%

Worsened metrics

Dev dependency count

1

increased byInfinity%

Number of lines in readme file

56

decreased by-61.9%

No dependency changes