Building an AML-IP Agent Node: A Practical Walkthrough

Building an AML-IP Agent Node: A Practical Walkthrough

The Agent Node relies on the eProsima DDS Router. This tool, developed and maintained by eProsima, enables the connection of distributed DDS networks. DDS entities such as publishers and subscribers deployed in one geographic location and using a dedicated local network will be able to communicate with other DDS entities deployed in different geographic areas on their dedicated local networks as if they were all on the same network.

This node communicates a local node or AML-IP cluster with the rest of the network in WANs. It centralises the WAN discovery and communication, i.e. it is the bridge for all the nodes in their LANs with the rest of the AML-IP components.

 

Install AML-IP

To install AML-IP, follow the guide provided in the following link.

Client Node

This node acts as a communication client that connects to a Server Node.

Steps

  • Import the corresponding modules.

code1.png

  • Create a new Address object with the address port, external address port, IP address and transport protocol.
  • Instantiate the ClientNode by creating an object of such class with a name, a connection address, and a domain.
  • Wait until Ctrl+C.

code2.jpeg

Server Node

This node acts as a communication server, waiting for other Client Nodes to connect to it.

Steps

 

  • Import the corresponding modules.

code3.jpeg 

  • Create a new Address object with the address port, external address port, IP address and transport protocol.
  • Instantiate the ServerNode by creating an object of such class with a name, a listening address, and a domain.
  • Wait until Ctrl+C.

code4.jpeg

Repeater Node

A Repeater Node can be used to repeat messages between networks; the message will be forwarded using the same network interface. This is useful for communicating across LANs.

 

Steps

  • Import the corresponding modules.

code5.jpeg

  • Create a new Address object with the address port, external address port, IP address and transport protocol.
  • Instantiate the RepeaterNode by creating an object of such class with a name, a listening address, and a domain.
  • Wait until Ctrl+C.

code6.jpeg

Configuration parameters

It is essential to understand the key arguments involved in setting up an efficient and reliable network communication system. Below is a breakdown of the primary configuration options:

Address Configuration

The Address object defines the network settings for a Participant. Key fields include:

  • Port (Internal Port):
    Specifies the local port where the Participant listens for incoming connections.
  • External Port:
    An external port is used to configure a Server (Discovery Server or Initial Peers) that runs under a NAT and uses TCP transport. It is only available for TCP communication. In UDP communication, the internal and external ports must coincide in the network router port forwarding rules.
  • Domain:
    The domain name or IP address of the host. If an IP is provided, this field is ignored.
  • Transport Protocol:
    Defines the communication protocol, either UDP for speed or TCP for reliability.

Agent Node Configuration

The Agent Node (ClientNode, ServerNode, RepeaterNode) represents a Participant in the system, connecting to remote servers or other nodes. Its key arguments include:

  • Name:
    A unique identifier for the Client Node, aiding in system-wide recognition and logging.
  • Connection Addresses:
    Connection addresses configure a connection with one or multiple remote WAN Participants (WAN participant case) or Discovery Servers (Discovery Server participant case). Listening addresses configure the network addresses where the Participant is going to listen for remote Participants.
  • Domain:
    The Domain ID isolates communication between Participants.

Conclusion

The AML-IP Agent Node, built on the eProsima DDS Router, is crucial in connecting distributed DDS networks across geographic locations. Configured as a Client, Server, or repeat node, it bridges local nodes with the broader network, enabling effective WAN discovery and communication. By following this guide and configuring ports, addresses, and transport protocols, you can build a reliable and scalable system for distributed DDS entities.

In the AML-IP Documentation, users can dive into more details about AML-IP Agent Node and AML-IP Agent Tool to get started.

 

By This email address is being protected from spambots. You need JavaScript enabled to view it. from eProsima.

 

MORE INFORMATION:

To learn more about AML, click here.

For any questions about ALMA, please contact This email address is being protected from spambots. You need JavaScript enabled to view it..

 

Logo ALMA

The ALMA project leverages AML properties to develop a new generation of interactive, human-centered machine learning systems.

Coordinator Office Address

Plaza de la Encina 10-11, Núcleo 4, 2ª Pl.
28760 Tres cantos - Madrid (España)

  • X
  • LinkedIn

EN-Funded_by_the_EU-POSThis project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 952091.