1.13.01.13.1An action represented by a message. The performative actions are a subset of the FIPA ACL recommendations for interagent communication.
Type: Object
- - - - - - - - - - - - - - - + + + + + + + + + + + + + + +An identifier for an agent or a topic.
- - - - - - - - - + + + + + + + + +(string)
name of the agent
(boolean
@@ -1239,37 +1239,37 @@
name of topic
(Gateway?)
Gateway owner for this AgentID
Gets the name of the agent or topic.
string:
name of agent or topic
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Returns true if the agent id represents a topic.
boolean:
true if the agent id represents a topic, false if it represents an agent
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Sends a message to the agent represented by this id.
(Message)
message to send
void:
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
Sends a request to the agent represented by this id and waits for a reponse.
- - - - - - - - - + + + + + + + + +(Message)
request to send
(number
@@ -1535,42 +1535,42 @@
timeout in milliseconds
Promise<Message>:
response
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Gets a string representation of the agent id.
string:
string representation of the agent id
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Gets a JSON string representation of the agent id.
string:
JSON string representation of the agent id
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Sets parameter(s) on the Agent referred to by this AgentID.
+Sets parameter(s) on the Agent referred to by this AgentID.
+ +(number
@@ -1766,9 +1766,9 @@
index of parameter(s) to be set
(number
@@ -1776,42 +1776,42 @@
timeout for the response
Promise<(Object | Array<Object>)>:
a promise which returns the new value(s) of the parameters
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Gets parameter(s) on the Agent referred to by this AgentID.
- - - - - - - - - + + + + + + + + +Base class for messages transmitted by one agent to another. Creates an empty message.
(Message?
@@ -1956,9 +1956,9 @@
message to which this response corresponds to
(Performative
@@ -1966,28 +1966,28 @@
performative
Gets a string representation of the message.
string:
string representation
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
A message class that can convey generic messages represented by key-value pairs.
Extends - + Message - +
- - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +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
(Object
= {})
-
+
opts.hostname string
-
+
(default "localhost")
|
hostname/ip address of the master container to connect to
@@ -2192,21 +2192,21 @@ | |
opts.port number
-
- (default 1100)
+ | opts.port string
+
+ (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)
@@ -2214,10 +2214,10 @@ | |
opts.keepAlive string
-
+ | opts.keepAlive boolean
+
(default true)
|
try to reconnect if the connection is lost
@@ -2225,10 +2225,10 @@ |
opts.queueSize number
-
+
(default 128)
|
size of the queue of received messages that haven't been consumed yet
@@ -2236,10 +2236,10 @@ | |
opts.timeout number
-
+
(default 1000)
|
timeout for fjage level messages in ms
@@ -2247,10 +2247,10 @@ | |
opts.returnNullOnFailedResponse boolean
-
+
(default true)
|
return null instead of throwing an error when a parameter is not found
@@ -2258,31 +2258,31 @@ |
Add an event listener to listen to various events happening on this Gateway
- - - - - - - - - + + + + + + + + +(string)
type of event to be listened to
(function)
new callback/function to be called when the event happens
void:
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
Remove an event listener.
- - - +Remove an event listener.
+ + + + + + + + + + + - - - - - - -(string)
type of event the listener was for
(function)
callback/function which was to be called when the event happens
void:
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
Add a new listener to listen to all {Message}s sent to this Gateway
(function)
new callback/function to be called when a {Message} is received
void:
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
Remove a message listener.
(function)
removes a previously registered listener/callback
void:
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
Add a new listener to get notified when the connection to master is created and terminated.
(function)
new callback/function to be called connection to master is created and terminated
void:
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
Remove a connection listener.
(function)
removes a previously registered listener/callback
void:
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
Gets the agent ID associated with the gateway.
AgentID:
agent ID
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Get an AgentID for a given agent name.
- - - - - - - - - + + + + + + + + +(string)
name of agent
AgentID:
AgentID for the given name
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Returns an object representing the named topic.
- - - - - - - - - + + + + + + + + +(string)
name of the topic if the topic param is an AgentID
AgentID:
object representing the topic
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Subscribes the gateway to receive all messages sent to the given topic.
- - - - - - - - - + + + + + + + + +(AgentID)
the topic to subscribe to
boolean:
true if the subscription is successful, false otherwise
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Unsubscribes the gateway from a given topic.
(AgentID)
the topic to unsubscribe
void:
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
Gets a list of all agents in the container.
- - - - - - - - - - - - + + + + + + + + + + + +Promise<Array<AgentID>>:
a promise which returns an array of all agent ids when resolved
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Check if an agent with a given name exists in the container.
- - - - - - - - - + + + + + + + + +Promise<boolean>:
a promise which returns true if the agent exists when resolved
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
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.
- - - - - - - - - + + + + + + + + +(string)
the named service of interest
Promise<AgentID?>:
a promise which returns an agent id for an agent that provides the service when resolved
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Finds all agents that provides a named service.
(string)
the named service of interest
Sends a message to the recipient indicated in the message. The recipient may be an agent or a topic.
- - - - - - - - - + + + + + + + + +(Message)
message to be sent
boolean:
if sending was successful
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Flush the Gateway queue for all pending messages. This drops all the pending messages.
void:
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
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.
- - - + + + + + + + + + + - - - - - - -(Message)
message to send
(number
@@ -3669,42 +3669,42 @@
timeout in milliseconds
Promise<(Message | void)>:
a promise which resolves with the received response message, null on timeout
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
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.
- - - - - - - - - + + + + + + + + +(any)
-
+
(number
@@ -3759,42 +3759,42 @@
timeout in milliseconds
Promise<(Message | void)>:
received response message, null on timeout
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
Closes the gateway. The gateway functionality may not longer be accessed after this method is called.
void:
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
Services supported by fjage agents.
Creates a unqualified message class based on a fully qualified name.
(string)
fully qualified name of the message class to be created
(any
= Message)
-
+
const ParameterReq = MessageClass('org.arl.fjage.param.ParameterReq');
let pReq = new ParameterReq()
-
-
-
-
-
-
+
+
+
+
+
+
Type: Object
- - - - - - - - - - + + + + + + + + + +A message that requests one or more parameters of an agent.
Type: Message
- - - - - - - - - - + + + + + + + + + +(string)
: parameters name to be get/set if only a single parameter is to be get/set
-
+
(Object)
: parameters value to be set if only a single parameter is to be set
-
+
(Array<ParameterReq.Entry>)
: a list of multiple parameters to be get/set
-
+
(number?)
: index of parameter(s) to be set
-
+