Messaging

A guide to agent messaging in SCOP Framework.

Overview

Communication between agents is established by exchanging Message objects. An Message is a discrete unit of communication intended by the source for consumption by some receiver(s) or group of receivers. It is ignorant to the agents and artifacts and deals only with their addresses.

Preparing a Message

When an agent wants to communicate with other agents, it has prepare an Message object as below by specifying the at least one receiver’s Identifier in the Message object.

For example, an agent can prepare a TYPE message for sending a String Hi there! payload to another agent called Carl as below:

Identifier sender = getIdentifier();
String paylaod = "Hi there!";
Identifier receiver = new Identifier("HW_Environment", Bystander.class, "Carl");
var message = new Message<String>("PING", sender, payload, receiver);

Here it should be noted that this aMessage is targeting Bystander of Carl. and it will be handled directly with that role. If Carl leaves the corresponding role (i.e. the role is inactive), then his Identifier becomes inactive and message no longer reaches Bystander of Carl.

That is to say, an agent message sent to a dedicated Identifier will not be delivered to the corresponding receiver role if the receiver agent has left the related role.

Sending a Message

To enable seamless communication between different agents, the SCOP Framework provides a simple and effective way to send messages using the sendMessage method, as illustrated by the following code snippet:

as(Communicator.class).sendMessage(message);

The as(Communicator.class) portion of the code is used to access the communication capabilities of an agent within the same environment of the role that call it. This syntax allows the agent to assume the role of a “Communicator” to send messages.

The sendMessage(Message) method is a built-in function provided by the SCOP Framework’s Communicator role. It serves as the primary mechanism for transmitting messages from one agent to another.

Receiving a Message

To receive a specific type of message, the dedicated role must implement a handler method whose signature as public void handleTYPEmessage(Message message) where TYPE is the type of the message. For instance, the aforementioned PING message can be handles as below:

public class Bystander extends Role {
   
   ...
   
   public void handlePINGMessage(Message message) {
      // code to handle the message
   }
}

The rest is managed by the SCOP Framework and the sent message is delivered to the dedicated handle methods. As a developer, you do not need to do anything else.

Note that, if the handler message is not implemented, the send messages will be lost.


Last modified January 10, 2025: Rename MAGE as SCOP (6a3f92c)