it.wldt.adapter.mqtt.physical.topic.outgoing.ActionOutgoingTopic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mqtt-physical-adapter Show documentation

Physical adapter to connect with the MQTT protocol

The newest version!

package it.wldt.adapter.mqtt.physical.topic.outgoing;

import it.wldt.adapter.mqtt.physical.topic.MqttQosLevel;

import java.util.function.Function;

/**
 * Represents an MQTT topic for outgoing actions in the context of a Digital Twin.
 * This class extends DigitalTwinOutgoingTopic and provides specialized functionality
 * for handling outgoing actions with a specific payload type.
 *
 * @param  The type of the payload associated with the action.
 * @author Marco Picone, Ph.D. - [email protected], Marta Spadoni University of Bologna
 */
public class ActionOutgoingTopic extends DigitalTwinOutgoingTopic {

    /**
     * Constructs an ActionOutgoingTopic with the specified MQTT topic and a function
     * to convert the action payload into the MQTT message body.
     *
     * @param topic              The MQTT topic associated with outgoing actions.
     * @param actionBodyConsumer A function to convert the action payload into the MQTT message body.
     */
    public ActionOutgoingTopic(String topic, Function actionBodyConsumer) {
        super(topic, actionWldtEvent -> actionBodyConsumer.apply((T) actionWldtEvent.getBody()));
    }

    /**
     * Constructs an ActionOutgoingTopic with the specified MQTT topic and a function
     * to convert the action payload into the MQTT message body.
     *
     * @param topic              The MQTT topic associated with outgoing actions.
     * @param mqttQosLevel       The Quality of Service (QoS) level associated with the topic.
     * @param isRetained         The retained flag.
     * @param actionBodyConsumer A function to convert the action payload into the MQTT message body.
     */
    public ActionOutgoingTopic(String topic, MqttQosLevel mqttQosLevel, boolean isRetained, Function actionBodyConsumer) {
        super(topic, mqttQosLevel, isRetained, actionWldtEvent -> actionBodyConsumer.apply((T) actionWldtEvent.getBody()));
    }
}