1.0.1 • Published 7 years ago

crossbar-connman v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
7 years ago

Description

crossbar-connman is a connections manager for crossbar which aims to make the use of connections transparent to the user.

API

Following are the functions the connman makes available. The parameters are in the format of type@name where type is the parameter type, like string or function and name is the parameter name.

Parameters marked with ... before mean they are variable parameters, i.e., you can have as many of them as you want, as long as you separate them by comas.

  • subscribe(string@host, string@topic, function@callback)
  • unsubscribe(string@host, ...string@topics)
  • publish(string@host, string@topic, ...object@args)
  • register(string@host, string@name, function@fn)
  • unregister(string@host, ...string@names)
  • call(string@host, string@name, ...object@args)
  • cleanup()

Usage

Simple subscribe/unsubscribe usage. The other methods from the API are used in a simillar fashion:

const connmanFactory = require( "crossbar-connman" );
const crossbar = connmanFactory();

const HOST = "ws://localhost:8080/ws";
const HOST2 = "ws://localhost:8081/ws";

crossbar.subscribe(HOST, "reader1.onRead", console.log)
    .then( () => crossbar.publish(HOST2, "reader1.onRead", "Hello World"))
    .then(() => crossbar.unsubscribe(HOST, "reader1.onRead"))
    .then( crossbar.cleanup ) //closes any open connections and frees memory.
    .catch( console.log );
1.0.1

7 years ago

1.0.0

7 years ago