Add new connection status and listerner to controllers

csowada · Jan 1, 2020 · bcabce4 · bcabce4
1 parent a01844e
commit bcabce4
Show file tree

Hide file tree

Showing 12 changed files with 128 additions and 17 deletions.
diff --git a/pom.xml b/pom.xml
@@ -7,7 +7,7 @@
 	<description>eBUS core library - This library handles the communication with heating engineering via the BUS specification. This protocol is used by many heating manufacturers in Europe.</description>
 	<groupId>de.cs-dev.ebus</groupId>
 	<artifactId>ebus-core</artifactId>
-	<version>1.0.0-SNAPSHOT</version>
+	<version>1.0.1-SNAPSHOT</version>
 	<url>https://github.com/csowada/ebus</url>
 	<packaging>bundle</packaging>
 
@@ -218,7 +218,7 @@
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
-			<version>1.7.5</version>
+			<version>1.7.25</version>
 		</dependency>
 
 		<dependency>

diff --git a/src/main/java/de/csdev/ebus/core/EBusConnectorEventListener.java b/src/main/java/de/csdev/ebus/core/EBusConnectorEventListener.java
@@ -8,6 +8,8 @@
  */
 package de.csdev.ebus.core;
 
+import de.csdev.ebus.core.IEBusController.ConnectionStatus;
+
 /**
  * @author Christian Sowada - Initial contribution
  *
@@ -44,4 +46,9 @@ public void onTelegramException(EBusDataException exception, Integer sendQueueId
     public void onConnectionException(Exception e) {
         // noop
     }
+
+    @Override
+    public void onConnectionStatusChanged(ConnectionStatus status) {
+        // noop
+    }
 }
diff --git a/src/main/java/de/csdev/ebus/core/EBusControllerBase.java b/src/main/java/de/csdev/ebus/core/EBusControllerBase.java
@@ -44,9 +44,11 @@ public abstract class EBusControllerBase extends Thread implements IEBusControll
 
     protected EBusQueue queue = new EBusQueue();
 
+    private ConnectionStatus connectionStatus = ConnectionStatus.DISCONNECTED;
+
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see de.csdev.ebus.core.IEBusController#addToSendQueue(byte[], int)
      */
     @Override
@@ -59,7 +61,7 @@ public Integer addToSendQueue(byte[] buffer, int maxAttemps) throws EBusControll
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see de.csdev.ebus.core.IEBusController#addToSendQueue(byte[])
      */
     @Override
@@ -72,7 +74,7 @@ public Integer addToSendQueue(byte[] buffer) throws EBusControllerException {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see de.csdev.ebus.core.IEBusController#addEBusEventListener(de.csdev.ebus.core.IEBusConnectorEventListener)
      */
     @Override
@@ -82,7 +84,7 @@ public void addEBusEventListener(IEBusConnectorEventListener listener) {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see de.csdev.ebus.core.IEBusController#removeEBusEventListener(de.csdev.ebus.core.IEBusConnectorEventListener)
      */
     @Override
@@ -173,6 +175,30 @@ public void run() {
         });
     }
 
+    /**
+     * @param status
+     */
+    protected void fireOnEBusConnectionStatusChange(ConnectionStatus status) {
+
+        if (threadPool == null || threadPool.isTerminated()) {
+            logger.warn("ThreadPool not ready!");
+            return;
+        }
+
+        threadPool.execute(new Runnable() {
+            @Override
+            public void run() {
+                for (IEBusConnectorEventListener listener : listeners) {
+                    try {
+                        listener.onConnectionStatusChanged(status);
+                    } catch (Exception e) {
+                        logger.error("Error while firing fireOnEBusConnectionStatusChange events!", e);
+                    }
+                }
+            }
+        });
+    }
+
     /**
      *
      */
@@ -210,7 +236,7 @@ protected void shutdownThreadPool() {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see de.csdev.ebus.core.IEBusController#isRunning()
      */
     @Override
@@ -265,7 +291,7 @@ public void run() {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see de.csdev.ebus.core.IEBusController#setWatchdogTimerTimeout(int)
      */
     @Override
@@ -283,4 +309,13 @@ protected void fireWatchDogTimer() {
         // }
     }
 
+    protected void setConnectionStatus(ConnectionStatus status) {
+        this.connectionStatus = status;
+        fireOnEBusConnectionStatusChange(status);
+    }
+
+    @Override
+    public ConnectionStatus getConnectionStatus() {
+        return this.connectionStatus;
+    }
 }
diff --git a/src/main/java/de/csdev/ebus/core/EBusEbusdController.java b/src/main/java/de/csdev/ebus/core/EBusEbusdController.java
@@ -55,6 +55,8 @@ public class EBusEbusdController extends EBusControllerBase {
 
     private Thread senderThread = null;
 
+    // private ConnectionStatus connectionStatus = ConnectionStatus.DISCONNECTED;
+
     public EBusEbusdController(String hostname, int port) {
         this.hostname = hostname;
         this.port = port;
@@ -136,6 +138,8 @@ private ByteBuffer parseLine(String readLine) throws IOException {
 
             directMode = true;
 
+            setConnectionStatus(ConnectionStatus.CONNECTED);
+
         } else if (!directMode) {
             logger.info("Switch ebusd to direct mode ...");
             // switch to direct mode
@@ -300,6 +304,9 @@ private void reconnect() throws IOException {
 
         logger.info("Try to reconnect to ebusd daemon ...");
 
+        // set connection status to connecting
+        setConnectionStatus(ConnectionStatus.CONNECTING);
+
         if (reConnectCounter > 10) {
             reConnectCounter = -1;
             this.interrupt();
@@ -339,6 +346,9 @@ private void disconnect() {
         socket = null;
 
         directMode = false;
+
+        // set connection status to disconnected
+        setConnectionStatus(ConnectionStatus.DISCONNECTED);
     }
 
     private boolean connect() throws UnknownHostException, IOException {

diff --git a/src/main/java/de/csdev/ebus/core/EBusLowLevelController.java b/src/main/java/de/csdev/ebus/core/EBusLowLevelController.java
@@ -111,6 +111,9 @@ private void reconnect() throws IOException {
 
         logger.info("Try to reconnect to eBUS adapter ...");
 
+        // set connection status to connecting
+        setConnectionStatus(ConnectionStatus.CONNECTING);
+
         if (reConnectCounter > 10) {
             reConnectCounter = -1;
             this.interrupt();
@@ -166,6 +169,9 @@ public void run() {
 
         try {
             if (!connection.isOpen()) {
+
+                setConnectionStatus(ConnectionStatus.CONNECTING);
+
                 connection.open();
             }
         } catch (IOException e) {
@@ -184,6 +190,9 @@ public void run() {
 
                 } else {
 
+                    // the connection is now connected
+                    setConnectionStatus(ConnectionStatus.CONNECTED);
+
                     // read byte from connector
                     read = connection.readBytes(buffer);
 
@@ -200,7 +209,6 @@ public void run() {
                         // reset with received data
                         resetWatchdogTimer();
                         reConnectCounter = 0;
-
                     }
                 }
 
@@ -419,6 +427,9 @@ protected void dispose() {
         } catch (IOException e) {
             logger.error(e.toString(), e);
         }
+
+        // set connection status to disconnected
+        setConnectionStatus(ConnectionStatus.DISCONNECTED);
     }
 
     @Override
@@ -432,4 +443,9 @@ protected void fireWatchDogTimer() {
         }
     }
 
+    // @Override
+    // public ConnectionStatus getConnectionStatus() {
+    // return this.connectionStatus;
+    // }
+
 }
diff --git a/src/main/java/de/csdev/ebus/core/IEBusConnectorEventListener.java b/src/main/java/de/csdev/ebus/core/IEBusConnectorEventListener.java
@@ -8,6 +8,8 @@
  */
 package de.csdev.ebus.core;
 
+import de.csdev.ebus.core.IEBusController.ConnectionStatus;
+
 /**
  * This listener is called if the connector received a valid eBUS telegram.
  *
@@ -38,4 +40,11 @@ public interface IEBusConnectorEventListener {
      * @param e
      */
     public void onConnectionException(Exception e);
+
+    /**
+     * The connection status has changed
+     * 
+     * @param status ConnectionStatus.CONNECTING, ConnectionStatus.CONNECTED or ConnectionStatus.DISCONNECTED
+     */
+    public void onConnectionStatusChanged(ConnectionStatus status);
 }
diff --git a/src/main/java/de/csdev/ebus/core/IEBusController.java b/src/main/java/de/csdev/ebus/core/IEBusController.java
@@ -45,4 +45,12 @@ public interface IEBusController {
     boolean isInterrupted();
 
     void interrupt();
+
+    enum ConnectionStatus {
+        DISCONNECTED,
+        CONNECTING,
+        CONNECTED
+    }
+
+    ConnectionStatus getConnectionStatus();
 }
diff --git a/src/main/java/de/csdev/ebus/service/metrics/EBusMetricsService.java b/src/main/java/de/csdev/ebus/service/metrics/EBusMetricsService.java
@@ -14,16 +14,16 @@
 import java.util.Map;
 
 import de.csdev.ebus.command.IEBusCommandMethod;
+import de.csdev.ebus.core.EBusConnectorEventListener;
 import de.csdev.ebus.core.EBusDataException;
 import de.csdev.ebus.core.EBusDataException.EBusError;
-import de.csdev.ebus.core.IEBusConnectorEventListener;
 import de.csdev.ebus.service.parser.IEBusParserListener;
 
 /**
  * @author Christian Sowada - Initial contribution
  *
  */
-public class EBusMetricsService implements IEBusParserListener, IEBusConnectorEventListener {
+public class EBusMetricsService extends EBusConnectorEventListener implements IEBusParserListener {
 
     private static final BigDecimal HUNDRED = BigDecimal.valueOf(100);
 

diff --git a/src/test/java/de/csdev/ebus/wip/ClientTest.java b/src/test/java/de/csdev/ebus/wip/ClientTest.java
@@ -23,10 +23,11 @@
 import de.csdev.ebus.command.EBusCommandRegistry;
 import de.csdev.ebus.command.IEBusCommandMethod;
 import de.csdev.ebus.command.datatypes.EBusTypeException;
-import de.csdev.ebus.core.EBusLowLevelController;
 import de.csdev.ebus.core.EBusDataException;
+import de.csdev.ebus.core.EBusLowLevelController;
 import de.csdev.ebus.core.EBusStateMachineTest;
 import de.csdev.ebus.core.IEBusConnectorEventListener;
+import de.csdev.ebus.core.IEBusController.ConnectionStatus;
 import de.csdev.ebus.core.connection.EBusEmulatorConnection;
 import de.csdev.ebus.service.parser.IEBusParserListener;
 import de.csdev.ebus.utils.EBusUtils;
@@ -74,6 +75,12 @@ public void onConnectionException(Exception e) {
                 logger.error("error!", e);
                 fail("No ConnectionException expected!");
             }
+
+            @Override
+            public void onConnectionStatusChanged(ConnectionStatus status) {
+                // logger.error("error!", e);
+                fail("No ConnectionException expected!");
+            }
         });
 
         client.getResolverService().addEBusParserListener(new IEBusParserListener() {

diff --git a/src/test/java/de/csdev/ebus/wip/ClientTest2.java b/src/test/java/de/csdev/ebus/wip/ClientTest2.java
@@ -20,11 +20,12 @@
 import de.csdev.ebus.command.EBusCommandRegistry;
 import de.csdev.ebus.command.IEBusCommandMethod;
 import de.csdev.ebus.command.datatypes.EBusTypeException;
-import de.csdev.ebus.core.EBusLowLevelController;
 import de.csdev.ebus.core.EBusControllerException;
 import de.csdev.ebus.core.EBusDataException;
+import de.csdev.ebus.core.EBusLowLevelController;
 import de.csdev.ebus.core.EBusStateMachineTest;
 import de.csdev.ebus.core.IEBusConnectorEventListener;
+import de.csdev.ebus.core.IEBusController.ConnectionStatus;
 import de.csdev.ebus.core.connection.EBusEmulatorConnection;
 import de.csdev.ebus.service.parser.IEBusParserListener;
 import de.csdev.ebus.utils.EBusUtils;
@@ -56,7 +57,6 @@ public void testNoSlaveResponse()
 
             @Override
             public void onTelegramReceived(byte[] receivedData, Integer sendQueueId) {
-                // TODO Auto-generated method stub
                 logger.error("ClientTest.xxx().new EBusConnectorEventListener() {...}.onTelegramReceived()");
             }
 
@@ -69,9 +69,14 @@ public void onTelegramException(EBusDataException exception, Integer sendQueueId
 
             @Override
             public void onConnectionException(Exception e) {
-                // TODO Auto-generated method stub
                 logger.error("ClientTest.xxx().new EBusConnectorEventListener() {...}.onConnectionException()");
             }
+
+            @Override
+            public void onConnectionStatusChanged(ConnectionStatus status) {
+                logger.error(
+                        "ClientTest2.testNoSlaveResponse().new IEBusConnectorEventListener() {...}.onConnectionStatusChanged()");
+            }
         });
 
         client.getResolverService().addEBusParserListener(new IEBusParserListener() {

diff --git a/src/test/java/de/csdev/ebus/wip/ClientTest3.java b/src/test/java/de/csdev/ebus/wip/ClientTest3.java
@@ -20,11 +20,12 @@
 import de.csdev.ebus.client.EBusClient;
 import de.csdev.ebus.command.EBusCommandRegistry;
 import de.csdev.ebus.command.datatypes.EBusTypeException;
-import de.csdev.ebus.core.EBusLowLevelController;
 import de.csdev.ebus.core.EBusControllerException;
 import de.csdev.ebus.core.EBusDataException;
+import de.csdev.ebus.core.EBusLowLevelController;
 import de.csdev.ebus.core.EBusStateMachineTest;
 import de.csdev.ebus.core.IEBusConnectorEventListener;
+import de.csdev.ebus.core.IEBusController.ConnectionStatus;
 import de.csdev.ebus.core.connection.EBusTCPConnection;
 import de.csdev.ebus.core.connection.IEBusConnection;
 import de.csdev.ebus.utils.EBusUtils;
@@ -71,9 +72,14 @@ public void onTelegramException(EBusDataException exception, Integer sendQueueId
 
             @Override
             public void onConnectionException(Exception e) {
-                // TODO Auto-generated method stub
                 logger.info("ClientTest.xxx().new EBusConnectorEventListener() {...}.onConnectionException()");
             }
+
+            @Override
+            public void onConnectionStatusChanged(ConnectionStatus status) {
+                logger.info(
+                        "ClientTest3.testNoSlaveResponse().new IEBusConnectorEventListener() {...}.onConnectionStatusChanged()");
+            }
         });
 
         // client.getResolverService().addEBusParserListener(new IEBusParserListener() {