Merge remote-tracking branch 'origin/dev'

Apollo3zehn · Aug 16, 2022 · c64541c · c64541c
2 parents c268739 + a53397b
commit c64541c
Show file tree

Hide file tree

Showing 39 changed files with 153 additions and 171 deletions.
diff --git a/sample/SampleServerClientRtu/Program.cs b/sample/SampleServerClientRtu/Program.cs
@@ -1,7 +1,4 @@
 using Microsoft.Extensions.Logging;
-using System;
-using System.Threading;
-using System.Threading.Tasks;
 
 namespace FluentModbus.SampleMaster
 {

diff --git a/sample/SampleServerClientRtu/SampleServerClientRtu.csproj b/sample/SampleServerClientRtu/SampleServerClientRtu.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <GenerateDocumentationFile>false</GenerateDocumentationFile>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>$(TargetFrameworkVersion)</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/sample/SampleServerClientTcp/Program.cs b/sample/SampleServerClientTcp/Program.cs
@@ -1,7 +1,4 @@
 using Microsoft.Extensions.Logging;
-using System;
-using System.Threading;
-using System.Threading.Tasks;
 
 namespace FluentModbus.SampleMaster
 {

diff --git a/sample/SampleServerClientTcp/SampleServerClientTcp.csproj b/sample/SampleServerClientTcp/SampleServerClientTcp.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <GenerateDocumentationFile>false</GenerateDocumentationFile>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>$(TargetFrameworkVersion)</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/FluentModbus/CastMemoryManager.cs b/src/FluentModbus/CastMemoryManager.cs
@@ -1,5 +1,4 @@
-using System;
-using System.Buffers;
+using System.Buffers;
 using System.Runtime.InteropServices;
 
 namespace FluentModbus

diff --git a/src/FluentModbus/Client/ModbusClient.cs b/src/FluentModbus/Client/ModbusClient.cs
@@ -1,5 +1,4 @@
-using System;
-using System.Runtime.InteropServices;
+using System.Runtime.InteropServices;
 
 namespace FluentModbus
 {

diff --git a/src/FluentModbus/Client/ModbusClientAsync.cs b/src/FluentModbus/Client/ModbusClientAsync.cs
@@ -1,16 +1,13 @@
 
- /* This is automatically translated code. */
+/* This is automatically translated code. */
 
 #pragma warning disable CS1998
 
-using System;
 using System.Runtime.InteropServices;
-using System.Threading;
-using System.Threading.Tasks;
 
 namespace FluentModbus
 {
-	public abstract partial class ModbusClient
+    public abstract partial class ModbusClient
 	{
         /// <summary>
         /// Sends the requested modbus message and waits for the response.

diff --git a/src/FluentModbus/Client/ModbusRtuClient.cs b/src/FluentModbus/Client/ModbusRtuClient.cs
@@ -1,6 +1,4 @@
-using System;
-using System.IO;
-using System.IO.Ports;
+using System.IO.Ports;
 
 namespace FluentModbus
 {
@@ -11,8 +9,8 @@ public partial class ModbusRtuClient : ModbusClient
     {
         #region Field
 
-        private IModbusRtuSerialPort _serialPort;
-        private ModbusFrameBuffer _frameBuffer;
+        private IModbusRtuSerialPort _serialPort = default!;
+        private ModbusFrameBuffer _frameBuffer = default!;
 
         #endregion
 
@@ -37,7 +35,7 @@ public bool IsConnected
         {
             get
             {
-                return _serialPort != null ? _serialPort.IsOpen : false;
+                return _serialPort is not null ? _serialPort.IsOpen : false;
             }
         }
 
@@ -93,7 +91,7 @@ public void Connect(string port)
         /// <param name="endianness">Specifies the endianness of the data exchanged with the Modbus server.</param>
         public void Connect(string port, ModbusEndianness endianness)
         {
-            var serialPort = new ModbusRtuSerialPort(new SerialPort(port)
+            var serialPort = ModbusRtuSerialPort.CreateInternal(new SerialPort(port)
             {
                 BaudRate = BaudRate,
                 Handshake = Handshake,
@@ -107,20 +105,20 @@ public void Connect(string port, ModbusEndianness endianness)
         }
 
         /// <summary>
-        /// Closes the opened COM port and frees all resources.
+        /// Connect to the specified <paramref name="serialPort"/>.
         /// </summary>
-        public void Close()
-        {
-            _serialPort?.Close();
-            _frameBuffer?.Dispose();
-        }
-
-        internal void Connect(IModbusRtuSerialPort serialPort)
+        /// <param name="serialPort">The externally managed <see cref="ModbusRtuSerialPort"/>.</param>
+        public void Connect(IModbusRtuSerialPort serialPort)
         {
             Connect(serialPort, ModbusEndianness.LittleEndian);
         }
 
-        internal void Connect(IModbusRtuSerialPort serialPort, ModbusEndianness endianness)
+        /// <summary>
+        /// Connect to the specified <paramref name="serialPort"/>.
+        /// </summary>
+        /// <param name="serialPort">The externally managed <see cref="ModbusRtuSerialPort"/>.</param>
+        /// <param name="endianness">Specifies the endianness of the data exchanged with the Modbus server.</param>
+        public void Connect(IModbusRtuSerialPort serialPort, ModbusEndianness endianness)
         {
             /* According to the spec (https://www.modbus.org/docs/Modbus_over_serial_line_V1_02.pdf), 
              * section 2.5.1 RTU Transmission Mode: "... the use of no parity requires 2 stop bits."
@@ -135,14 +133,31 @@ internal void Connect(IModbusRtuSerialPort serialPort, ModbusEndianness endianne
 
             _frameBuffer = new ModbusFrameBuffer(256);
 
-            _serialPort?.Close();
+            if (_serialPort is ModbusRtuSerialPort maybeInternalPort && maybeInternalPort.IsInternal)
+                maybeInternalPort.Close();
+
             _serialPort = serialPort;
-            _serialPort.Open();
+
+            if (!_serialPort.IsOpen)
+                _serialPort.Open(); 
+        }
+
+        /// <summary>
+        /// Closes the opened COM port and frees all resources.
+        /// </summary>
+        public void Close()
+        {
+            if (_serialPort is ModbusRtuSerialPort maybeInternalPort && maybeInternalPort.IsInternal)
+                maybeInternalPort.Close();
+
+            _frameBuffer?.Dispose();
         }
 
         ///<inheritdoc/>
         protected override Span<byte> TransceiveFrame(byte unitIdentifier, ModbusFunctionCode functionCode, Action<ExtendedBinaryWriter> extendFrame)
         {
+            // WARNING: IF YOU EDIT THIS METHOD, REFLECT ALL CHANGES ALSO IN TransceiveFrameAsync!
+
             int frameLength;
             byte rawFunctionCode;
             ushort crc;

diff --git a/src/FluentModbus/Client/ModbusRtuClientAsync.cs b/src/FluentModbus/Client/ModbusRtuClientAsync.cs
@@ -1,14 +1,8 @@
-
- /* This is automatically translated code. */
-
-using System;
-using System.IO;
-using System.Threading;
-using System.Threading.Tasks;
+/* This is automatically translated code. */
 
 namespace FluentModbus
 {
-	public partial class ModbusRtuClient
+    public partial class ModbusRtuClient
 	{
 		///<inheritdoc/>
         protected override async Task<Memory<byte>> TransceiveFrameAsync(byte unitIdentifier, ModbusFunctionCode functionCode, Action<ExtendedBinaryWriter> extendFrame, CancellationToken cancellationToken = default)

diff --git a/src/FluentModbus/Client/ModbusTcpClient.cs b/src/FluentModbus/Client/ModbusTcpClient.cs
@@ -1,9 +1,6 @@
-using System;
-using System.IO;
-using System.Net;
+using System.Net;
 using System.Net.Sockets;
 using System.Runtime.InteropServices;
-using System.Threading;
 
 namespace FluentModbus
 {
@@ -17,9 +14,9 @@ public partial class ModbusTcpClient : ModbusClient
         private ushort _transactionIdentifierBase;
         private object _transactionIdentifierLock;
 
-        private TcpClient _tcpClient;
-        private NetworkStream _networkStream;
-        private ModbusFrameBuffer _frameBuffer;
+        private TcpClient? _tcpClient;
+        private NetworkStream _networkStream = default!;
+        private ModbusFrameBuffer _frameBuffer = default!;
 
         #endregion
 
@@ -100,7 +97,13 @@ public void Connect(string remoteEndpoint, ModbusEndianness endianness)
             if (!ModbusUtils.TryParseEndpoint(remoteEndpoint.AsSpan(), out var parsedRemoteEndpoint))
                 throw new FormatException("An invalid IPEndPoint was specified.");
 
+        #if NETSTANDARD2_0
+            Connect(parsedRemoteEndpoint!, endianness);
+        #endif
+
+        #if NETSTANDARD2_1_OR_GREATER
             Connect(parsedRemoteEndpoint, endianness);
+        #endif
         }
 
         /// <summary>
@@ -170,6 +173,8 @@ public void Disconnect()
         ///<inheritdoc/>
         protected override Span<byte> TransceiveFrame(byte unitIdentifier, ModbusFunctionCode functionCode, Action<ExtendedBinaryWriter> extendFrame)
         {
+            // WARNING: IF YOU EDIT THIS METHOD, REFLECT ALL CHANGES ALSO IN TransceiveFrameAsync!
+
             int frameLength;
             int partialLength;
 

diff --git a/src/FluentModbus/Client/ModbusTcpClientAsync.cs b/src/FluentModbus/Client/ModbusTcpClientAsync.cs
@@ -1,14 +1,9 @@
-
- /* This is automatically translated code. */
-
-using System;
-using System.IO;
-using System.Threading;
-using System.Threading.Tasks;
+/* This is automatically translated code. */
+
 
 namespace FluentModbus
 {
-	public partial class ModbusTcpClient
+    public partial class ModbusTcpClient
 	{
 		///<inheritdoc/>
         protected override async Task<Memory<byte>> TransceiveFrameAsync(byte unitIdentifier, ModbusFunctionCode functionCode, Action<ExtendedBinaryWriter> extendFrame, CancellationToken cancellationToken = default)

diff --git a/src/FluentModbus/ExtendedBinaryReader.cs b/src/FluentModbus/ExtendedBinaryReader.cs
@@ -1,6 +1,4 @@
-using System;
-using System.IO;
-using System.Runtime.InteropServices;
+using System.Runtime.InteropServices;
 
 namespace FluentModbus
 {

diff --git a/src/FluentModbus/ExtendedBinaryWriter.cs b/src/FluentModbus/ExtendedBinaryWriter.cs
@@ -1,7 +1,4 @@
-using System;
-using System.IO;
-
-namespace FluentModbus
+namespace FluentModbus
 {
     /// <summary>
     /// A binary writer with extended capability to handle big-endian data.

diff --git a/src/FluentModbus/IModbusRtuSerialPort.cs b/src/FluentModbus/IModbusRtuSerialPort.cs
@@ -1,7 +1,4 @@
-using System.Threading;
-using System.Threading.Tasks;
-
-namespace FluentModbus
+namespace FluentModbus
 {
     /// <summary>
     /// A serial port for Modbus RTU communication.

diff --git a/src/FluentModbus/ModbusException.cs b/src/FluentModbus/ModbusException.cs
@@ -1,6 +1,4 @@
-using System;
-
-namespace FluentModbus
+namespace FluentModbus
 {
     /// <summary>
     /// This exception is used for Modbus protocol errors.

diff --git a/src/FluentModbus/ModbusFrameBuffer.cs b/src/FluentModbus/ModbusFrameBuffer.cs
@@ -1,6 +1,4 @@
-using System;
-using System.Buffers;
-using System.IO;
+using System.Buffers;
 
 namespace FluentModbus
 {