nxjs

Nexus Javascript / Node.js Client

Nexus client for web browser/node.js built using gopherjs, wrapping around the golang nexus client

Requirements

• GopherJS
  • go get github.com/gopherjs/gopherjs

Requirements for node.js:

• WebSocket module 'ws'
  • npm -g install ws

Build

$ gopherjs build

API

// WIP: Missing a proper documentation. These are pseudo-go headers

    // On browsers
    Nexus(url, callback) (NexusConnection, error)

    // On Node.js
    var nexus = require("./nxjs.js")
    nexus.Dial(url, callback) (NexusConnection, error)

    NexusConnection Object:
        func Login(user string, pass string, callback)
        
        func TaskPush(method string, params interface{}, timeout int, callback)
        func TaskPull(prefix string, timeout int, callback) (Task, error)
        
        func UserCreate(user string, pass string, callback)
        func UserDelete(user string, callback)
        func UserDelTags(user string, prefix string, tags []string, callback)
        func UserSetPass(user string, pass string, callback)
        func UserSetTags(user string, prefix string, tags map[string]{}, callback)
        
        func PipeCreate(opts interface{}, callback) (Pipe, error)
        func PipeOpen(id string, callback) (Pipe, error)
        
        func ChanPublish(channel string, msg interface{}, callback)
        func ChanSubscribe(pipe Pipe, channel string, callback)
        func ChanUnsubscribe(pipe Pipe, channel string, callback)
        
        func Exec(method string, params interface{}, callback)
        func ExecNoWait(method string, params interface{}, callback)
        
        func Cancel(callback)
        func Closed(callback)
        func Ping(timeout int, callback)
        
    Task Object:
        func SendResult(res interface{}, callback)
        func SendError(code int, msg string, data interface{}, callback)
        field Path
        field Method
        field Params
        field Tags

    Pipe Object:
        func Close(callback)
        func Read(max int, timeout int, callback)
        func Write(msg {}, callback)
        func Id(callback) string

Functions can receive zero, one or two parameters at the end for callbacks.

If there is only one callback parameter, it should be a function with two arguments:

	TaskPull("prefix", 60, function(result, error) {
		console.log("This is the result:", result)
		console.log("Error received:", error)
	}

With two callback parameters, one will receive the result and the other the error:

	Login("user", "pass", function(result) {
		console.log("Logged in!")
	}, function(error) {
		console.log("Couldn't login!:", error)
	})

Examples

Pull a task from a browser

// The module will set dial as a global function when loaded
Nexus("wss://localhost.n4m.zone", function(nc, err){

	// Login to nexus
  nc.Login("dummyUser", "dummyPassword", function(){
  
  	// Success! Now pull a task
    nc.TaskPull("test.prefix", 5, function(task, err){
    
    	// Great! Just return an OK
      console.log(task, err);
      task.SendResult("OK");
    })
    
  })
})

Subscribe a pipe to a channel

var nexus = require("./nxjs.js")

nexus.dial("wss://localhost.n4m.zone", function(nc, err){
  nc.Login("dummyUser", "dummyPass", function(){
  
  	// Create a pipe
    nc.PipeCreate({"len": 100}, function(pipe, e){
    
    	// Subscribe the pipe to the channel
      nc.ChanSubscribe(pipe, "temperatures",
      
        //Subscription succeeded
        function(){
          console.log("Subscribed pipe", pipe.Id(), "to channel temperatures")
        
          pipe.Read(10, 60, function(msgs, err){
           console.log("Received messages:", msgs)
          })
        },
        
        // Subscription failed
        function(err){ console.log("Error subscribing the pipe to the channel:", err)})
    })
  })
})