fjage 1.13.5 | Documentation

fjage

1.13.5

Performative ▸
- Static members
- .REQUEST
- .AGREE
- .REFUSE
- .FAILURE
- .INFORM
- .CONFIRM
- .DISCONFIRM
- .QUERY_IF
- .NOT_UNDERSTOOD
- .CFP
- .PROPOSE
- .CANCEL
AgentID ▸
- Instance members
- #getName
- #isTopic
- #send
- #request
- #toString
- #toJSON
- #set
- #get
Message ▸
- Instance members
- #toString
GenericMessage
Gateway ▸
- Instance members
- #addEventListener
- #removeEventListener
- #addMessageListener
- #removeMessageListener
- #addConnListener
- #removeConnListener
- #getAgentID
- #agent
- #topic
- #subscribe
- #unsubscribe
- #agents
- #containsAgent
- #agentForService
- #agentsForService
- #send
- #flush
- #request
- #receive
- #close
Services ▸
- Static members
- .SHELL
MessageClass
ParameterReq.Entry
ParameterReq

Performative

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

Performative

Type: string

Static Members

▸ REQUEST

gateways/js/src/fjage.js

REQUEST

▸ AGREE

gateways/js/src/fjage.js

AGREE

▸ REFUSE

gateways/js/src/fjage.js

REFUSE

▸ FAILURE

gateways/js/src/fjage.js

FAILURE

▸ INFORM

gateways/js/src/fjage.js

INFORM

▸ CONFIRM

gateways/js/src/fjage.js

CONFIRM

▸ DISCONFIRM

gateways/js/src/fjage.js

DISCONFIRM

▸ QUERY_IF

gateways/js/src/fjage.js

QUERY_IF

▸ NOT_UNDERSTOOD

gateways/js/src/fjage.js

NOT_UNDERSTOOD

▸ CFP

gateways/js/src/fjage.js

CFP

▸ PROPOSE

gateways/js/src/fjage.js

PROPOSE

▸ CANCEL

gateways/js/src/fjage.js

CANCEL

AgentID

gateways/js/src/fjage.js

An identifier for an agent or a topic.

new AgentID(name: string, topic: boolean, owner: Gateway?)

Parameters

name (string) name of the agent

topic

(boolean
            = false)

name of topic

owner (Gateway?) Gateway owner for this AgentID

Instance Members

▸ getName()

gateways/js/src/fjage.js

Gets the name of the agent or topic.

getName(): string

Returns

string: name of agent or topic

▸ isTopic()

gateways/js/src/fjage.js

Returns true if the agent id represents a topic.

isTopic(): boolean

Returns

boolean: true if the agent id represents a topic, false if it represents an agent

▸ send(msg)

gateways/js/src/fjage.js

Sends a message to the agent represented by this id.

send(msg: Message): void

Parameters

msg (Message) message to send

Returns

void:

▸ request(msg, timeout)

gateways/js/src/fjage.js

Sends a request to the agent represented by this id and waits for a reponse.

request(msg: Message, timeout: number): Promise<Message>

Parameters

msg (Message) request to send

timeout

(number
            = 1000)

timeout in milliseconds

Returns

Promise<Message>: response

▸ toString()

gateways/js/src/fjage.js

Gets a string representation of the agent id.

toString(): string

Returns

string: string representation of the agent id

▸ toJSON()

gateways/js/src/fjage.js

Gets a JSON string representation of the agent id.

toJSON(): string

Returns

string: JSON string representation of the agent id

▸ set(params, values, index, timeout)

gateways/js/src/fjage.js

Sets parameter(s) on the Agent referred to by this AgentID.

set(params: (string | Array<string>), values: (Object | Array<Object>), index: number, timeout: number): Promise<(Object | Array<Object>)>

Parameters

params ((string | Array<string>)) parameters name(s) to be set

values ((Object | Array<Object>)) parameters value(s) to be set

index

(number
            = -1)

index of parameter(s) to be set

timeout

(number
            = 5000)

timeout for the response

Returns

Promise<(Object | Array<Object>)>: a promise which returns the new value(s) of the parameters

▸ get(params, index, timeout)

gateways/js/src/fjage.js

Gets parameter(s) on the Agent referred to by this AgentID.

get(params: any, index: number, timeout: number)

Parameters

params (any)

index

(number
            = -1)

index of parameter(s) to be get

timeout

(number
            = 5000)

timeout for the response

Message

gateways/js/src/fjage.js

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

new Message(inReplyTo: Message?, perf: Performative)

Parameters

inReplyTo

(Message?
            = {msgID:null,sender:null})

message to which this response corresponds to

perf

(Performative
            = Performative.INFORM)

performative

Instance Members

▸ toString()

gateways/js/src/fjage.js

Gets a string representation of the message.

toString(): string

Returns

string: string representation

GenericMessage

gateways/js/src/fjage.js

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

new GenericMessage()

Extends Message

Gateway

gateways/js/src/fjage.js

A gateway for connecting to a fjage master container. The new version of the constructor uses an options object instead of individual parameters. The old version with

new Gateway(opts: Object)

Parameters

opts

(Object
            = {})

Name	Description
opts.hostname `string` (default `"localhost"`)	hostname/ip address of the master container to connect to
opts.port `number` (default `1100`)	port number of the master container to connect to
opts.pathname `string` (default `""`)	path of the master container to connect to (for WebSockets)
opts.keepAlive `string` (default `true`)	try to reconnect if the connection is lost
opts.queueSize `number` (default `128`)	size of the queue of received messages that haven't been consumed yet
opts.timeout `number` (default `1000`)	timeout for fjage level messages in ms
opts.returnNullOnFailedResponse `boolean` (default `true`)	return null instead of throwing an error when a parameter is not found

Instance Members

▸ addEventListener(type, listener)

gateways/js/src/fjage.js

Add an event listener to listen to various events happening on this Gateway

addEventListener(type: string, listener: function): void

Parameters

type (string) type of event to be listened to

listener (function) new callback/function to be called when the event happens

Returns

void:

▸ removeEventListener(type, listener)

gateways/js/src/fjage.js

Remove an event listener.

removeEventListener(type: string, listener: function): void

Parameters

type (string) type of event the listener was for

listener (function) callback/function which was to be called when the event happens

Returns

void:

▸ addMessageListener(listener)

gateways/js/src/fjage.js

Add a new listener to listen to all {Message}s sent to this Gateway

addMessageListener(listener: function): void

Parameters

listener (function) new callback/function to be called when a {Message} is received

Returns

void:

▸ removeMessageListener(listener)

gateways/js/src/fjage.js

Remove a message listener.

removeMessageListener(listener: function): void

Parameters

listener (function) removes a previously registered listener/callback

Returns

void:

▸ addConnListener(listener)

gateways/js/src/fjage.js

Add a new listener to get notified when the connection to master is created and terminated.

addConnListener(listener: function): void

Parameters

listener (function) new callback/function to be called connection to master is created and terminated

Returns

void:

▸ removeConnListener(listener)

gateways/js/src/fjage.js

Remove a connection listener.

removeConnListener(listener: function): void

Parameters

listener (function) removes a previously registered listener/callback

Returns

void:

▸ getAgentID()

gateways/js/src/fjage.js

Gets the agent ID associated with the gateway.

getAgentID(): AgentID

Returns

AgentID: agent ID

▸ agent(name)

gateways/js/src/fjage.js

Get an AgentID for a given agent name.

agent(name: string): AgentID

Parameters

name (string) name of agent

Returns

AgentID: AgentID for the given name

▸ topic(topic, topic2)

gateways/js/src/fjage.js

Returns an object representing the named topic.

topic(topic: (string | AgentID), topic2: string): AgentID

Parameters

topic ((string | AgentID)) name of the topic or AgentID

topic2 (string) name of the topic if the topic param is an AgentID

Returns

AgentID: object representing the topic

▸ subscribe(topic)

gateways/js/src/fjage.js

Subscribes the gateway to receive all messages sent to the given topic.

subscribe(topic: AgentID): boolean

Parameters

topic (AgentID) the topic to subscribe to

Returns

boolean: true if the subscription is successful, false otherwise

▸ unsubscribe(topic)

gateways/js/src/fjage.js

Unsubscribes the gateway from a given topic.

unsubscribe(topic: AgentID): void

Parameters

topic (AgentID) the topic to unsubscribe

Returns

void:

▸ agents()

gateways/js/src/fjage.js

Gets a list of all agents in the container.

agents(): Promise<Array<AgentID>>

Returns

Promise<Array<AgentID>>: a promise which returns an array of all agent ids when resolved

▸ containsAgent(agentID)

gateways/js/src/fjage.js

Check if an agent with a given name exists in the container.

containsAgent(agentID: (AgentID | String)): Promise<boolean>

Parameters

agentID ((AgentID | String)) the agent id to check

Returns

Promise<boolean>: a promise which returns true if the agent exists when resolved

▸ agentForService(service)

gateways/js/src/fjage.js

Finds an agent that provides a named service. If multiple agents are registered to provide a given service, any of the agents' id may be returned.

agentForService(service: string): Promise<AgentID?>

Parameters

service (string) the named service of interest

Returns

Promise<AgentID?>: a promise which returns an agent id for an agent that provides the service when resolved

▸ agentsForService(service)

gateways/js/src/fjage.js

Finds all agents that provides a named service.

agentsForService(service: string)

Parameters

service (string) the named service of interest

▸ send(msg)

gateways/js/src/fjage.js

Sends a message to the recipient indicated in the message. The recipient may be an agent or a topic.

send(msg: Message): boolean

Parameters

msg (Message) message to be sent

Returns

boolean: if sending was successful

▸ flush()

gateways/js/src/fjage.js

Flush the Gateway queue for all pending messages. This drops all the pending messages.

flush(): void

Returns

void:

▸ request(msg, timeout)

gateways/js/src/fjage.js

Sends a request and waits for a response. This method returns a {Promise} which resolves when a response is received or if no response is received after the timeout.

request(msg: Message, timeout: number): Promise<(Message | void)>

Parameters

msg (Message) message to send

timeout

(number
            = 1000)

timeout in milliseconds

Returns

Promise<(Message | void)>: a promise which resolves with the received response message, null on timeout

▸ receive(filter, timeout)

gateways/js/src/fjage.js

Returns a response message received by the gateway. This method returns a {Promise} which resolves when a response is received or if no response is received after the timeout.

receive(filter: any, timeout: number): Promise<(Message | void)>

Parameters

filter (any)

timeout

(number
            = 0)

timeout in milliseconds

Returns

Promise<(Message | void)>: received response message, null on timeout

▸ close()

gateways/js/src/fjage.js

Closes the gateway. The gateway functionality may not longer be accessed after this method is called.

close(): void

Returns

void:

Services

gateways/js/src/fjage.js

Services supported by fjage agents.

Services

Static Members

▸ SHELL

gateways/js/src/fjage.js

SHELL

MessageClass

gateways/js/src/fjage.js

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

new MessageClass(name: string, parent: any)

Parameters

name (string) fully qualified name of the message class to be created

parent

(any
            = Message)

Example

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

ParameterReq.Entry

gateways/js/src/fjage.js

ParameterReq.Entry

Type: Object

Properties

param (string) : parameter name

value (Object) : parameter value

ParameterReq

gateways/js/src/fjage.js

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

ParameterReq

Type: Message

Properties

param (string) : parameters name to be get/set if only a single parameter is to be get/set

value (Object) : parameters value to be set if only a single parameter is to be set

requests (Array<ParameterReq.Entry>) : a list of multiple parameters to be get/set

index (number?) : index of parameter(s) to be set