100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
MQTT Client improvement to try and avoid blocking call when sending (#893)
Rich Turnerd306fcb67d23
diff --git a/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java b/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.javaindex b7b5f2a32..e3d017378 100644--- a/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java+++ b/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java@@ -20,8 +20,10 @@package org.openremote.agent.protocol.mqtt;import com.hivemq.client.mqtt.MqttClient;+import com.hivemq.client.mqtt.MqttClientState;import com.hivemq.client.mqtt.exceptions.ConnectionClosedException;import com.hivemq.client.mqtt.exceptions.ConnectionFailedException;+import com.hivemq.client.mqtt.exceptions.MqttClientStateException;import com.hivemq.client.mqtt.lifecycle.MqttDisconnectSource;import com.hivemq.client.mqtt.mqtt3.Mqtt3AsyncClient;import com.hivemq.client.mqtt.mqtt3.Mqtt3ClientBuilder;@@ -70,7 +72,6 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<Sprotected final Set<Consumer<ConnectionStatus>> connectionStatusConsumers = new CopyOnWriteArraySet<>();protected final Map<String, Set<Consumer<MQTTMessage<S>>>> topicConsumerMap = new HashMap<>();protected ScheduledExecutorService executorService;- protected ConnectionStatus connectionStatus = ConnectionStatus.DISCONNECTED;protected boolean disconnected = true; // Need to use this flag to cancel client reconnect taskprotected Consumer<String> topicSubscribeFailureConsumer;@@ -91,10 +92,7 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<SMqtt3ClientBuilder builder = MqttClient.builder().useMqttVersion3().identifier(clientId)- .addConnectedListener(context -> {- LOG.info("Client is connected to the broker '" + getClientUri() + "'");- onConnectionStatusChanged(ConnectionStatus.CONNECTED);- })+ .addConnectedListener(context -> onConnectionStatusChanged()).addDisconnectedListener(context -> {boolean userClosed = context.getSource() == MqttDisconnectSource.USER;if (disconnected) {@@ -118,7 +116,7 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<S} else if (context.getCause() instanceof ConnectionFailedException) {LOG.log(Level.INFO, "Connection failed '" + getClientUri() + "': initiator=" + context.getSource(), context.getCause());}- onConnectionStatusChanged(userClosed ? ConnectionStatus.DISCONNECTED : ConnectionStatus.WAITING);+ onConnectionStatusChanged();}).automaticReconnect().initialDelay(RECONNECT_DELAY_INITIAL_MILLIS, TimeUnit.MILLISECONDS)@@ -156,17 +154,22 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<S} catch (Exception e) {LOG.log(Level.WARNING, "Invalid MQTT client config for client '" + getClientUri() + "'", e);client = null;- connectionStatus = ConnectionStatus.ERROR;}}@Overridepublic void sendMessage(MQTTMessage<S> message) {if (client == null) {- LOG.info("Cannot send message as client is invalid '" + getClientUri() + "'");+ LOG.info("Cannot send message as client is invalid: " + getClientUri());+ return;+ }++ if (getConnectionStatus() != ConnectionStatus.CONNECTED) {+ LOG.info("Cannot send message as client is not connected: " + getClientUri());return;}+ // TODO: Might need to put some timeout logic here as this call can block if client becomes disconnected see (https://github.com/hivemq/hivemq-mqtt-client/issues/554)client.publishWith().topic(message.topic).payload(messageToBytes(message.payload))@@ -235,7 +238,7 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<S});};- if (this.connectionStatus != ConnectionStatus.CONNECTED) {+ if (getConnectionStatus() != ConnectionStatus.CONNECTED) {// Just return true and let connection logic sort out actual subscriptionreturn true;}@@ -319,19 +322,25 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<S@Overridepublic ConnectionStatus getConnectionStatus() {- return connectionStatus;+ if (client == null) {+ return ConnectionStatus.ERROR;+ }+ MqttClientState state = client.getState();+ if (state == MqttClientState.CONNECTED) {+ return ConnectionStatus.CONNECTED;+ }+ if (state == MqttClientState.DISCONNECTED) {+ return ConnectionStatus.DISCONNECTED;+ }++ // We cannot differentiate between connecting and waiting with the callbacks provided so just use waiting state+ return ConnectionStatus.WAITING;}@Overridepublic void connect() {- synchronized (this) {- if (getConnectionStatus() != ConnectionStatus.DISCONNECTED) {- LOG.finer("Must be disconnected and not in error before calling connect: " + getClientUri());- return;- }-- LOG.fine("Connecting MQTT Client: " + getClientUri());- onConnectionStatusChanged(ConnectionStatus.CONNECTING);+ if (client == null) {+ return;}this.disconnected = false;@@ -372,22 +381,20 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<S});}- protected void onConnectionStatusChanged(ConnectionStatus connectionStatus) {- if (this.connectionStatus == connectionStatus) {- return;- }+ protected void onConnectionStatusChanged() {+ executorService.submit(() -> {+ ConnectionStatus status = getConnectionStatus();+ LOG.info("Client '" + getClientUri() + "' connection status changed: " + status);- this.connectionStatus = connectionStatus;-- executorService.submit(() ->connectionStatusConsumers.forEach(consumer -> {try {- consumer.accept(connectionStatus);+ consumer.accept(status);} catch (Exception e) {LOG.log(Level.WARNING, "Connection status change handler threw an exception: " + getClientUri(), e);}- }));+ });+ });}@Override@@ -396,26 +403,25 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<Sreturn;}- synchronized (this) {- if (connectionStatus == ConnectionStatus.DISCONNECTED) {- LOG.finest("Already disconnected: " + getClientUri());- return;- }-- LOG.finest("Disconnecting IO client: " + getClientUri());- onConnectionStatusChanged(ConnectionStatus.DISCONNECTING);- }+ LOG.finest("Disconnecting IO client: " + getClientUri());+ client.disconnect();this.disconnected = true;client.disconnect().whenComplete((unused, throwable) -> {- onConnectionStatusChanged(ConnectionStatus.DISCONNECTED);- if (this.cleanSession) {- removeAllMessageConsumers();+ if (throwable instanceof MqttClientStateException) {+ // Likely already disconnected+ return;}if (throwable != null) {- LOG.info("Failed to disconnect");+ LOG.log(Level.WARNING, "Failed to disconnect: " + getClientUri(), throwable);+ return;}+ if (this.cleanSession) {+ removeAllMessageConsumers();+ }++ onConnectionStatusChanged();});}