Shet-client NPM

A client library for SHET. It can be used in Node.js, or in web browsers using Socket.IO.

Get

npm install shet-client

Use

In Node.js

var shet = new (require("shet-client").Client)();

In the browser

This uses Socket.IO, so it's probably easiest to get that working first (see http://socket.io/#how-to-use).

Install as above, then use Browserify to generate a single library file:

browserify -r shet-client -o public/shet.js

Include this in your page, then add the something like this to the server:

# after "io = require('socket.io').listen(app)"
require("shet-client").listen_socket(io);

...and something like this to the client:

# after "var socket = io.connect(...);"
var shet = new (require("shet-client").Client)(socket);

This creates a SHET client, that can be used exactly as in Node.

The API

Rather than using callbacks for everything, this library uses Q to provide 'deferred values' or 'promises', as in the Twisted version.

var c = new Client()

Create a new client. The host and port to connect to are taken from $SHET_HOST and $SHET_PORT, and default to localhost:11235, as is standard.

var c = new Client(socket)

Create a new client connected to the given Socket.IO channel.

listen_socket(socket)

Accept connections on the given Socket.IO channel, and pass traffic to the SHET server (which is resolved as above).

c.add_action(path, callback)

Add an action. When the action is called, callback will be called with the appropriate arguments, and it's return value will be returned to the caller. If callback returns a Q promise, it will wait for this to resolve before returning, as expected.

c.add_event(path)

Add an event. This returns an object with a raise attribute. Calling this with any number of arguments raises the event with the given arguments.

c.add_prop(path, get_cb, set_cb)

Add a property. get_cb should take no arguments and return the desired value of the property. set_cb should take a single argument, and set the property.