You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by jf...@apache.org on 2019/03/29 09:51:44 UTC
[incubator-plc4x] 01/02: PLC4X-108 Added "ping" based isConnected
method.
This is an automated email from the ASF dual-hosted git repository.
jfeinauer pushed a commit to branch feature/PLC4X-108-ping-method
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git
commit 9c0dacbe2e5864d1c3323d32a7a4f031b61c7694
Author: julian <j....@pragmaticminds.de>
AuthorDate: Fri Mar 29 10:32:09 2019 +0100
PLC4X-108 Added "ping" based isConnected method.
---
.../connection/SimulatedPlcConnection.java | 7 +++
.../base/connection/AbstractPlcConnection.java | 55 ++++++++++++++++++++++
.../plc4x/java/base/connection/ChannelFactory.java | 8 ++++
.../java/base/connection/NettyPlcConnection.java | 9 ++++
.../base/connection/AbstractPlcConnectionTest.java | 8 ++++
.../base/connection/NettyPlcConnectionTest.java | 17 ++++++-
.../base/connection/RawSocketChannelFactory.java | 7 +++
.../java/base/connection/SerialChannelFactory.java | 8 ++++
.../base/connection/TcpSocketChannelFactory.java | 7 +++
.../java/base/connection/TestChannelFactory.java | 7 +++
10 files changed, 132 insertions(+), 1 deletion(-)
diff --git a/plc4j/drivers/simulated/src/main/java/org/apache/plc4x/java/simulated/connection/SimulatedPlcConnection.java b/plc4j/drivers/simulated/src/main/java/org/apache/plc4x/java/simulated/connection/SimulatedPlcConnection.java
index 805d9af..07fc20f 100644
--- a/plc4j/drivers/simulated/src/main/java/org/apache/plc4x/java/simulated/connection/SimulatedPlcConnection.java
+++ b/plc4j/drivers/simulated/src/main/java/org/apache/plc4x/java/simulated/connection/SimulatedPlcConnection.java
@@ -29,6 +29,7 @@ import org.apache.plc4x.java.base.messages.*;
import org.apache.plc4x.java.base.messages.items.BaseDefaultFieldItem;
import org.apache.plc4x.java.base.model.*;
+import java.net.InetSocketAddress;
import java.time.Instant;
import java.util.*;
import java.util.concurrent.CompletableFuture;
@@ -64,6 +65,12 @@ public class SimulatedPlcConnection extends AbstractPlcConnection implements Plc
}
@Override
+ protected Optional<InetSocketAddress> getInetSocketAddress() {
+ // IS okay, isConnected is overridden
+ return Optional.empty();
+ }
+
+ @Override
public void close() {
connected = false;
}
diff --git a/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/AbstractPlcConnection.java b/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/AbstractPlcConnection.java
index cef1786..ba7cca8 100644
--- a/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/AbstractPlcConnection.java
+++ b/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/AbstractPlcConnection.java
@@ -18,6 +18,7 @@ under the License.
*/
package org.apache.plc4x.java.base.connection;
+import org.apache.commons.lang3.NotImplementedException;
import org.apache.plc4x.java.api.PlcConnection;
import org.apache.plc4x.java.api.exceptions.PlcUnsupportedOperationException;
import org.apache.plc4x.java.api.messages.PlcReadRequest;
@@ -26,8 +27,13 @@ import org.apache.plc4x.java.api.messages.PlcUnsubscriptionRequest;
import org.apache.plc4x.java.api.messages.PlcWriteRequest;
import org.apache.plc4x.java.api.metadata.PlcConnectionMetadata;
import org.apache.plc4x.java.base.messages.InternalPlcMessage;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import java.net.InetSocketAddress;
+import java.net.Socket;
import java.util.Objects;
+import java.util.Optional;
/**
* Base class for implementing connections.
@@ -37,6 +43,10 @@ import java.util.Objects;
*/
public abstract class AbstractPlcConnection implements PlcConnection, PlcConnectionMetadata {
+ private static final Logger LOGGER = LoggerFactory.getLogger(AbstractPlcConnection.class);
+
+ private static final int PING_TIMEOUT_MS = 1_000;
+
@Override
public PlcConnectionMetadata getMetadata() {
return this;
@@ -57,6 +67,51 @@ public abstract class AbstractPlcConnection implements PlcConnection, PlcConnect
return false;
}
+ /**
+ * The default implementation uses the {@link #ping(int)} method.
+ * Drivers that want to implement a more specific version have to overide it.
+ */
+ @Override
+ public boolean isConnected() {
+ return ping(PING_TIMEOUT_MS);
+ }
+
+ /**
+ * Method that sends a test-request or ping to the PLC to check if the PLC is still there.
+ * In most cases this method should only be used from the {@link #isConnected()} method.
+ * This method can only be used if ghe {@link #getInetSocketAddress()} returns a Socket Adress.
+ * Otherwise it throws a {@link NotImplementedException} to inform the user about that.
+ */
+ protected boolean ping(int timeout) {
+ Optional<InetSocketAddress> address = getInetSocketAddress();
+ if (!address.isPresent()) {
+ throw new NotImplementedException("Tries to check the connection with ping, " +
+ "but no Socket Address is given!");
+ }
+ Socket s = null;
+ try {
+ s = new Socket();
+ s.connect(address.get(), timeout);
+ return true;
+ } catch (Exception e) {
+ LOGGER.debug("Unable to ping PLC", e);
+ return false;
+ } finally {
+ if (s != null) {
+ try {
+ s.close();
+ } catch (Exception e) {
+ }
+ }
+ }
+ }
+
+ /**
+ * Strategy Pattern method for the {@link #ping(int)} method.
+ * If a driver has no Inet Socket adress, it has to return an Empty Optional, never null.
+ */
+ protected abstract Optional<InetSocketAddress> getInetSocketAddress();
+
@Override
public PlcReadRequest.Builder readRequestBuilder() {
throw new PlcUnsupportedOperationException("The connection does not support reading");
diff --git a/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/ChannelFactory.java b/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/ChannelFactory.java
index b3e3e6b..55e245a 100644
--- a/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/ChannelFactory.java
+++ b/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/ChannelFactory.java
@@ -22,9 +22,17 @@ import io.netty.channel.Channel;
import io.netty.channel.ChannelHandler;
import org.apache.plc4x.java.api.exceptions.PlcConnectionException;
+import java.net.InetSocketAddress;
+import java.util.Optional;
+
public interface ChannelFactory {
Channel createChannel(ChannelHandler channelHandler)
throws PlcConnectionException;
+ /**
+ * If this Channel Facotry creates a Channel which has an ip / port it should return this
+ */
+ Optional<InetSocketAddress> getInetSocketAddress();
+
}
diff --git a/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/NettyPlcConnection.java b/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/NettyPlcConnection.java
index cd4c1ca..5f27f6b 100644
--- a/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/NettyPlcConnection.java
+++ b/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/connection/NettyPlcConnection.java
@@ -25,6 +25,8 @@ import io.netty.util.Timer;
import org.apache.plc4x.java.api.exceptions.PlcConnectionException;
import org.apache.plc4x.java.api.exceptions.PlcIoException;
+import java.net.InetSocketAddress;
+import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
@@ -94,10 +96,17 @@ public abstract class NettyPlcConnection extends AbstractPlcConnection {
connected = false;
}
+ /**
@Override
public boolean isConnected() {
return connected && channel.isActive();
}
+ */
+
+ @Override
+ protected Optional<InetSocketAddress> getInetSocketAddress() {
+ return this.channelFactory.getInetSocketAddress();
+ }
public Channel getChannel() {
return channel;
diff --git a/plc4j/protocols/driver-bases/base/src/test/java/org/apache/plc4x/java/base/connection/AbstractPlcConnectionTest.java b/plc4j/protocols/driver-bases/base/src/test/java/org/apache/plc4x/java/base/connection/AbstractPlcConnectionTest.java
index 2064709..0d2b098 100644
--- a/plc4j/protocols/driver-bases/base/src/test/java/org/apache/plc4x/java/base/connection/AbstractPlcConnectionTest.java
+++ b/plc4j/protocols/driver-bases/base/src/test/java/org/apache/plc4x/java/base/connection/AbstractPlcConnectionTest.java
@@ -26,6 +26,9 @@ import org.apache.plc4x.java.base.messages.PlcReader;
import org.assertj.core.api.WithAssertions;
import org.junit.jupiter.api.Test;
+import java.net.InetSocketAddress;
+import java.util.Optional;
+
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.mock;
@@ -43,6 +46,11 @@ class AbstractPlcConnectionTest implements WithAssertions {
}
@Override
+ protected Optional<InetSocketAddress> getInetSocketAddress() {
+ return Optional.empty();
+ }
+
+ @Override
public void close() {
throw new NotImplementedException("not used");
}
diff --git a/plc4j/protocols/driver-bases/base/src/test/java/org/apache/plc4x/java/base/connection/NettyPlcConnectionTest.java b/plc4j/protocols/driver-bases/base/src/test/java/org/apache/plc4x/java/base/connection/NettyPlcConnectionTest.java
index 3c9bcb8..78269c3 100644
--- a/plc4j/protocols/driver-bases/base/src/test/java/org/apache/plc4x/java/base/connection/NettyPlcConnectionTest.java
+++ b/plc4j/protocols/driver-bases/base/src/test/java/org/apache/plc4x/java/base/connection/NettyPlcConnectionTest.java
@@ -23,16 +23,31 @@ import io.netty.channel.Channel;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.embedded.EmbeddedChannel;
+import org.apache.plc4x.java.api.exceptions.PlcConnectionException;
import org.apache.plc4x.java.base.events.ConnectEvent;
import org.assertj.core.api.WithAssertions;
import org.junit.jupiter.api.Test;
+import java.net.InetSocketAddress;
+import java.util.Optional;
import java.util.concurrent.CompletableFuture;
public class NettyPlcConnectionTest implements WithAssertions {
- NettyPlcConnection SUT = new NettyPlcConnection(EmbeddedChannel::new, true) {
+ private final ChannelFactory channelFactory = new ChannelFactory() {
+ @Override
+ public Channel createChannel(ChannelHandler channelHandler) throws PlcConnectionException {
+ return new EmbeddedChannel();
+ }
+
+ @Override
+ public Optional<InetSocketAddress> getInetSocketAddress() {
+ return Optional.empty();
+ }
+ };
+
+ NettyPlcConnection SUT = new NettyPlcConnection(channelFactory, true) {
@Override
protected ChannelHandler getChannelHandler(CompletableFuture<Void> sessionSetupCompleteFuture) {
sessionSetupCompleteFuture.complete(null);
diff --git a/plc4j/protocols/driver-bases/raw-socket/src/main/java/org/apache/plc4x/java/base/connection/RawSocketChannelFactory.java b/plc4j/protocols/driver-bases/raw-socket/src/main/java/org/apache/plc4x/java/base/connection/RawSocketChannelFactory.java
index a6fe95e..fb77caf 100644
--- a/plc4j/protocols/driver-bases/raw-socket/src/main/java/org/apache/plc4x/java/base/connection/RawSocketChannelFactory.java
+++ b/plc4j/protocols/driver-bases/raw-socket/src/main/java/org/apache/plc4x/java/base/connection/RawSocketChannelFactory.java
@@ -23,6 +23,8 @@ import io.netty.channel.ChannelHandler;
import org.apache.plc4x.java.api.exceptions.PlcConnectionException;
import java.net.InetAddress;
+import java.net.InetSocketAddress;
+import java.util.Optional;
public class RawSocketChannelFactory implements ChannelFactory {
@@ -37,6 +39,11 @@ public class RawSocketChannelFactory implements ChannelFactory {
}
@Override
+ public Optional<InetSocketAddress> getInetSocketAddress() {
+ return Optional.of(new InetSocketAddress(address, port));
+ }
+
+ @Override
public Channel createChannel(ChannelHandler channelHandler)
throws PlcConnectionException {
/*try {
diff --git a/plc4j/protocols/driver-bases/serial/src/main/java/org/apache/plc4x/java/base/connection/SerialChannelFactory.java b/plc4j/protocols/driver-bases/serial/src/main/java/org/apache/plc4x/java/base/connection/SerialChannelFactory.java
index cdfea8f..f95f618 100644
--- a/plc4j/protocols/driver-bases/serial/src/main/java/org/apache/plc4x/java/base/connection/SerialChannelFactory.java
+++ b/plc4j/protocols/driver-bases/serial/src/main/java/org/apache/plc4x/java/base/connection/SerialChannelFactory.java
@@ -28,6 +28,9 @@ import io.netty.channel.jsc.JSerialCommDeviceAddress;
import io.netty.channel.oio.OioEventLoopGroup;
import org.apache.plc4x.java.api.exceptions.PlcConnectionException;
+import java.net.InetSocketAddress;
+import java.util.Optional;
+
public class SerialChannelFactory implements ChannelFactory {
private final String serialPort;
@@ -37,6 +40,11 @@ public class SerialChannelFactory implements ChannelFactory {
}
@Override
+ public Optional<InetSocketAddress> getInetSocketAddress() {
+ return Optional.empty();
+ }
+
+ @Override
public Channel createChannel(ChannelHandler channelHandler)
throws PlcConnectionException {
JSerialCommDeviceAddress address = new JSerialCommDeviceAddress(serialPort);
diff --git a/plc4j/protocols/driver-bases/tcp/src/main/java/org/apache/plc4x/java/base/connection/TcpSocketChannelFactory.java b/plc4j/protocols/driver-bases/tcp/src/main/java/org/apache/plc4x/java/base/connection/TcpSocketChannelFactory.java
index 0631e1a..cc77358 100644
--- a/plc4j/protocols/driver-bases/tcp/src/main/java/org/apache/plc4x/java/base/connection/TcpSocketChannelFactory.java
+++ b/plc4j/protocols/driver-bases/tcp/src/main/java/org/apache/plc4x/java/base/connection/TcpSocketChannelFactory.java
@@ -28,6 +28,8 @@ import io.netty.channel.socket.nio.NioSocketChannel;
import org.apache.plc4x.java.api.exceptions.PlcConnectionException;
import java.net.InetAddress;
+import java.net.InetSocketAddress;
+import java.util.Optional;
public class TcpSocketChannelFactory implements ChannelFactory {
@@ -69,4 +71,9 @@ public class TcpSocketChannelFactory implements ChannelFactory {
public int getPort() {
return port;
}
+
+ @Override
+ public Optional<InetSocketAddress> getInetSocketAddress() {
+ return Optional.of(new InetSocketAddress(address, port));
+ }
}
diff --git a/plc4j/protocols/driver-bases/test/src/main/java/org/apache/plc4x/java/base/connection/TestChannelFactory.java b/plc4j/protocols/driver-bases/test/src/main/java/org/apache/plc4x/java/base/connection/TestChannelFactory.java
index be58968..ec27290 100644
--- a/plc4j/protocols/driver-bases/test/src/main/java/org/apache/plc4x/java/base/connection/TestChannelFactory.java
+++ b/plc4j/protocols/driver-bases/test/src/main/java/org/apache/plc4x/java/base/connection/TestChannelFactory.java
@@ -22,6 +22,9 @@ import io.netty.channel.Channel;
import io.netty.channel.ChannelHandler;
import io.netty.channel.embedded.EmbeddedChannel;
+import java.net.InetSocketAddress;
+import java.util.Optional;
+
public class TestChannelFactory implements ChannelFactory {
private EmbeddedChannel channel;
@@ -36,4 +39,8 @@ public class TestChannelFactory implements ChannelFactory {
return channel;
}
+ @Override
+ public Optional<InetSocketAddress> getInetSocketAddress() {
+ return Optional.empty();
+ }
}