postal.js

mirror of https://github.com/Hopiu/postal.js.git synced 2026-03-17 14:40:24 +00:00

History

Jim Cowart 951738d56b Reformatted code to more closely (but not exactly) line up with jQuery core formatting standards. Updated postal.socket dependencies in the node example, etc.		2012-04-21 00:56:40 -04:00
..
examples	Reformatted code to more closely (but not exactly) line up with jQuery core formatting standards. Updated postal.socket dependencies in the node example, etc.	2012-04-21 00:56:40 -04:00
lib	Reformatted code to more closely (but not exactly) line up with jQuery core formatting standards. Updated postal.socket dependencies in the node example, etc.	2012-04-21 00:56:40 -04:00
test	Reformatted code to more closely (but not exactly) line up with jQuery core formatting standards. Updated postal.socket dependencies in the node example, etc.	2012-04-21 00:56:40 -04:00
LICENSE	Adding working rough draft of node sample application	2012-04-18 01:05:32 -04:00
Makefile	Adding working rough draft of node sample application	2012-04-18 01:05:32 -04:00
package.json	Reformatted code to more closely (but not exactly) line up with jQuery core formatting standards. Updated postal.socket dependencies in the node example, etc.	2012-04-21 00:56:40 -04:00
README.md	Adding working rough draft of node sample application	2012-04-18 01:05:32 -04:00

README.md

A prototype Web Socket client implementation for node.js.

Tested with miksago/node-websocket-server v1.2.00.

Requires nodejs 0.1.98 or later.

Installation

Install this using npm as follows

npm install websocket-client

... or just dump lib/websocket.js in your $NODE_PATH.

Usage

var sys = require('sys');
var WebSocket = require('websocket').WebSocket;

var ws = new WebSocket('ws://localhost:8000/biff', 'borf');
ws.addListener('data', function(buf) {
    sys.debug('Got data: ' + sys.inspect(buf));
});
ws.onmessage = function(m) {
    sys.debug('Got message: ' + m);
}

API

This supports the send() and onmessage() APIs. The WebSocket object will also emit data events that are node Buffer objects, in case you want to work with something lower-level than strings.

Transports

Multiple transports are supported, indicated by the scheme provided to the WebSocket constructor. ws:// is a standard TCP-based Web Socket; ws+unix:// allows connection to a UNIX socket at the given path.