fjage

fjåge JavaScript Gateway (fjage.js)

A fjåge Gateway implementation in JavaScript supports both browser (WebSocket) and Node.js (TCP) based connections to a fjåge Master Container.

Versions

fjage.js is included as a part of the fjage.jar package and also available seperately as a npm package.

fjage.js v2.0.0

fjage.js v2.0.0 enables automatic registration of subscriptions with the master container using WANTS_MESSAGES_FOR action. This is done everytime a fjage.js client subscribes to a topic. A change in fjåge to support a non-aggregating WebSocketConnector enable this performance improvement in fjage.js. This is a breaking change from fjage.js v1.x.x, where all messages were sent to all fjage.js clients.

The change doesn't affect the usage of fjage.js in the browser, but it does make fjage.js ≥2.0.0 incompatible with fjåge < 2.0.0.

Installation

$ npm install fjage

Documentation

The API documentation of the latest version of fjage.js is published at https://org-arl.github.io/fjage/jsdoc/

Usage

A distribution-ready bundle is available for types of module systems commonly used in the JS world. Examples of how to use it for the different module systems are available in the examples directory.

At runtime, fjage.js will check its context (browser or Node.js) and accordingly use the appropriate Connector for connecting to the master container.

CommonJS

const { Performative, AgentID, Message, Gateway, MessageClass } = require('fjage');
const shell = new AgentID('shell');
const gw = new Gateway({
    hostname: 'localhost',
    port : '5081',
});

ECMAScript modules

import { Performative, AgentID, Message, Gateway, MessageClass } from 'fjage.js'
const shell = new AgentID('shell');
const gw = new Gateway({
    hostname: 'localhost',
    port : '5081',
});

UMD

<script src="fjage.min.js"></script>
<script>
    const shell = new fjage.AgentID('shell');
    const gw = new fjage.Gateway({
        hostname: 'localhost',
        port : '8080',
        pathname: '/ws/'
    });
</script>