git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.mqtt.discovery;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.openhab.core.io.transport.mqtt.MqttBrokerConnection;
  17 import org.openhab.core.thing.ThingUID;
  18
  19 /**
  20  * Implement this interface to get notified of received values and vanished topics.
  21  *
  22  * @author David Graeff - Initial contribution
  23  */
  24 @NonNullByDefault
  25 public interface MQTTTopicDiscoveryParticipant {
  26     /**
  27      * Called whenever a message on the subscribed topic got published or a retained message was received.
  28      *
  29      * @param thingUID The MQTT thing UID of the Thing that established/created the given broker connection.
  30      * @param connection The broker connection
  31      * @param topic The topic
  32      * @param payload The topic payload
  33      */
  34     void receivedMessage(ThingUID thingUID, MqttBrokerConnection connection, String topic, byte[] payload);
  35
  36     /**
  37      * A MQTT topic vanished.
  38      *
  39      * @param thingUID The MQTT thing UID of the Thing that established/created the given broker connection.
  40      * @param connection The broker connection
  41      * @param topic The topic
  42      */
  43     void topicVanished(ThingUID thingUID, MqttBrokerConnection connection, String topic);
  44 }