A gateway for connecting to a fjage master container. This class provides methods to send and receive messages, subscribe to topics, and manage connections to the master container. It can be used to connect to a fjage master container over WebSockets or TCP.

Connects to the localhost:1100

const gw = new Gateway({ hostname: 'localhost', port: 1100 });

Connects to the origin

const gw = new Gateway();

An identifier for an agent or a topic. This can be to send, receive messages, and set or get parameters on an agent or topic on the fjåge master container.

Services supported by fjage agents.

An action represented by a message. The performative actions are a subset of the FIPA ACL recommendations for interagent communication.

Type: string

Base class for messages transmitted by one agent to another. Creates an empty message.

Creates a unqualified message class based on a fully qualified name.

const ParameterReq = MessageClass('org.arl.fjage.param.ParameterReq');
let pReq = new ParameterReq()

A message that requests one or more parameters of an agent.

Type: Message

Setting a parameter myAgent.x to 42

let req = new ParameterReq({
 recipient: myAgentId,
 param: 'x',
 value: 42
});

Getting the value of myAgent.x

let req = new ParameterReq({
recipient: myAgentId,
param: 'x'
});

Type: Object

A message class that can convey generic messages represented by key-value pairs.

Extends Message

Class representing a fjage's on-the-wire JSON message. A JSONMessage object contains all the fields that can be a part of a fjage JSON message. The class provides methods to create JSONMessage objects from raw strings and to convert JSONMessage objects to JSON strings in the format of the fjage on-the-wire protocol. See fjage documentation for more details on the JSON message format.

Most users will not need to create JSONMessage objects directly, but rather use the Gateway and Message classes to send and receive messages. However, this class can be useful for low-level access to the fjage protocol or for generating/consuming the fjåge protocol messages without having them be transmitted over a network.

const jsonMsg = new JSONMessage();
jsonMsg.action = 'send';
jsonMsg.message = new Message();
jsonMsg.message.sender = new AgentID('agent1');
jsonMsg.message.recipient = new AgentID('agent2');
jsonMsg.message.perf = Performative.INFORM;
jsonMsg.toJSON(); // Converts to JSON string in the fjage on-the-wire protocol format

const jsonString = '{"id":"1234",...}'; // JSON string representation of a JSONMessage
const jsonMsg = new JSONMessage(jsonString); // Parses the JSON string into a JSONMessage object
jsonMsg.message; // Access the Message object contained in the JSONMessage

A message that is a response to a ParameterReq message.

Type: Message

Receiving a parameter from myAgent

let rsp = gw.receive(ParameterRsp)
rsp.sender // = myAgentId; sender of the message
rsp.param  // = 'x'; parameter name that was get/set
rsp.value  // = 42;  value of the parameter that was set
rsp.readonly // = [false]; indicates if the parameter is read-only

Actions supported by the fjåge JSON message protocol. See fjage documentation for more details.

Type: string