Skip to content
Browse files

rename to axon

  • Loading branch information...
1 parent 948033f commit afe7fd5d9ec3be27ddbf0b93b767612d3bb5d458 @tj committed Aug 3, 2012
Showing with 20 additions and 20 deletions.
  1. +19 −19 Readme.md
  2. +1 −1 package.json
View
38 Readme.md
@@ -1,10 +1,10 @@
-# Super Sockets
+# Axon
- Super Sockets is a message-oriented socket library for node.js heavily inspired by zeromq.
+ axon is a message-oriented socket library for node.js heavily inspired by zeromq.
## Installation
- $ npm install super-sockets
+ $ npm install axon
## Features
@@ -23,8 +23,8 @@
`PushSocket`s distribute messages round-robin:
```js
-var ss = require('super-sockets')
- , sock = ss.socket('push');
+var axon = require('axon')
+ , sock = axon.socket('push');
sock.bind(3000);
console.log('push server started');
@@ -37,8 +37,8 @@ setInterval(function(){
Receiver of `PushSocket` messages:
```js
-var ss = require('super-sockets')
- , sock = ss.socket('pull');
+var axon = require('axon')
+ , sock = axon.socket('pull');
sock.connect(3000);
@@ -63,8 +63,8 @@ to push results:
`PubSocket`s send messages to all subscribers without queueing:
```js
-var ss = require('super-sockets')
- , sock = ss.socket('pub');
+var axon = require('axon')
+ , sock = axon.socket('pub');
sock.bind(3000);
console.log('pub server started');
@@ -77,8 +77,8 @@ setInterval(function(){
`SubSocket` provides selective reception of messages from a `PubSocket`:
```js
-var ss = require('super-sockets')
- , sock = ss.socket('sub');
+var axon = require('axon')
+ , sock = axon.socket('sub');
sock.connect(3000);
@@ -96,8 +96,8 @@ the "json" codec. Currently we simply choose define the `EmitterSocket` as a `Pu
server.js:
```js
-var ss = require('super-sockets')
- , sock = ss.socket('emitter');
+var axon = require('axon')
+ , sock = axon.socket('emitter');
sock.bind(3000);
console.log('pub server started');
@@ -110,8 +110,8 @@ setInterval(function(){
client.js:
```js
-var ss = require('super-sockets')
- , sock = ss.socket('emitter');
+var axon = require('axon')
+ , sock = axon.socket('emitter');
sock.connect(3000);
console.log('sub client connected');
@@ -136,7 +136,7 @@ sock.on('login', function(user){
+------+------+------+------+------------------...
```
- Thus 5 bytes is the smallest message super sockets supports at the moment. Later if
+ Thus 5 bytes is the smallest message axon supports at the moment. Later if
necessary we can use the meta to indicate a small message and ditch octet 2 and 3
allowing for 3 byte messages.
@@ -146,7 +146,7 @@ sock.on('login', function(user){
here is the JSON codec:
```js
-var ss = require('super-sockets');
+var ss = require('axon');
ss.codec.define('json', {
encode: JSON.stringify,
@@ -155,7 +155,7 @@ ss.codec.define('json', {
```
__Note:__ codecs must be defined on both the sending and receiving ends, otherwise
- super sockets cannot properly decode the messages. You may of course ignore this
+ axon cannot properly decode the messages. You may of course ignore this
feature all together and simply pass encoded data to `.send()`.
## Performance
@@ -191,7 +191,7 @@ ss.codec.define('json', {
Super sockets are not meant to combat zeromq nor provide feature parity,
but provide a nice solution when you don't need the insane
nanosecond latency or language interoperability that zeromq provides
- as super sockets do not rely on any third-party compiled libraries.
+ as axon do not rely on any third-party compiled libraries.
## Running tests
View
2 package.json
@@ -1,5 +1,5 @@
{
- "name": "super-sockets",
+ "name": "axon",
"description": "High-level messaging & socket patterns implemented in pure js",
"version": "0.0.3",
"author": "TJ Holowaychuk <tj@vision-media.ca>",

0 comments on commit afe7fd5

Please sign in to comment.
Something went wrong with that request. Please try again.