Merge pull request #487 from GridProtectionAlliance/FixPIConnectionTimeoutAssignment

Fix PI connection timeout assignment

Author: StephenCWills

Source/Libraries/Adapters/PIAdapters/PIBufferInputAdapter.cs

@@ -21,22 +21,16 @@
 //
 //******************************************************************************************************
 
-using GSF;
 using GSF.Diagnostics;
-using GSF.TimeSeries;
 using GSF.TimeSeries.Adapters;
 using OSIsoft.AF.Asset;
 using OSIsoft.AF.PI;
 using OSIsoft.AF.Time;
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
-using System.Data;
 using System.Linq;
 using System.Text;
-using System.Threading;
-using System.Timers;
-using Timer = System.Timers.Timer;
 
 namespace PIAdapters;
 
@@ -53,8 +47,8 @@ public class PIBufferInputAdapter : InputAdapterBase
     private const int DefaultPageFactor = 1;
 
     // Fields
-    private PIConnection m_connection;                                  // PI server connection
-    private IEnumerator<AFValue> m_dataReader;                          // Data reader
+    private PIConnection m_connection;          // PI server connection
+    private IEnumerator<AFValue> m_dataReader;  // Data reader
     private AFTime m_startTime;
     private AFTime m_stopTime;
     private bool m_disposed;
@@ -66,7 +60,7 @@ public class PIBufferInputAdapter : InputAdapterBase
     /// <summary>
     /// Creates a new instance of the <see cref="PIAdapters.PIBufferInputAdapter"/>.
     /// </summary>
-    public PIBufferInputAdapter() {}
+    public PIBufferInputAdapter() { }
 
     #endregion
 
@@ -103,10 +97,6 @@ public PIBufferInputAdapter() {}
     [DefaultValue(PIConnection.DefaultConnectTimeout)]
     public int ConnectTimeout { get; set; }
 
-  
-
-
-
     /// <summary>
     /// Gets or sets value paging factor to read more data per page from PI.
     /// </summary>
@@ -119,7 +109,7 @@ public PIBufferInputAdapter() {}
     /// Gets the flag indicating if this adapter supports temporal processing.
     /// </summary>
     public override bool SupportsTemporalProcessing => false;
-    
+
 
     /// <summary>
     /// Returns the detailed status of the data input source.
@@ -129,17 +119,19 @@ public override string Status
         get
         {
             StringBuilder status = new();
+
             status.Append(base.Status);
+            status.AppendLine($"        OSI-PI server name: {ServerName}");
+            status.AppendLine($"       Connected to server: {(m_connection is null ? "No" : m_connection.Connected ? "Yes" : "No")}");
+            status.AppendLine($"             Paging factor: {PageFactor:#,##0}");
+            status.AppendLine($"            Start time-tag: {m_startTime}");
+            status.AppendLine($"             Stop time-tag: {m_stopTime}");
 
-            status.AppendFormat("        OSI-PI server name: {0}\r\n", ServerName);
-            status.AppendFormat("       Connected to server: {0}\r\n", m_connection is null ? "No" : m_connection.Connected ? "Yes" : "No");
-            status.AppendFormat("             Paging factor: {0:#,##0}\r\n", PageFactor);
-            status.AppendFormat("            Start time-tag: {0}\r\n", m_startTime);
-            status.AppendFormat("             Stop time-tag: {0}\r\n", m_stopTime);
             return status.ToString();
         }
     }
 
+    /// <inheritdoc />
     protected override bool UseAsyncConnect => false;
 
     #endregion
@@ -152,25 +144,25 @@ public override string Status
     /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
     protected override void Dispose(bool disposing)
     {
-        if (!m_disposed)
+        if (m_disposed)
+            return;
+        
+        try
         {
-            try
+            if (!disposing)
+                return;
+            
+            if (m_connection is not null)
             {
-                if (disposing)
-                {
-                    if (m_connection is not null)
-                    {
-                        m_connection.Dispose();
-                        m_connection = null;
-                    }
-                }
-            }
-            finally
-            {
-                m_disposed = true;          // Prevent duplicate dispose.
-                base.Dispose(disposing);    // Call base class Dispose().
+                m_connection.Dispose();
+                m_connection = null;
             }
         }
+        finally
+        {
+            m_disposed = true;          // Prevent duplicate dispose.
+            base.Dispose(disposing);    // Call base class Dispose().
+        }
     }
 
     /// <summary>
@@ -195,8 +187,6 @@ public override void Initialize()
 
         ConnectTimeout = settings.TryGetValue(nameof(ConnectTimeout), out setting) ? Convert.ToInt32(setting) : PIConnection.DefaultConnectTimeout;
 
-
-
         if (settings.TryGetValue(nameof(PageFactor), out setting) && int.TryParse(setting, out int pageFactor) && pageFactor > 0)
             PageFactor = pageFactor;
         else
@@ -220,15 +210,18 @@ public override string GetShortStatus(int maxLength)
     /// </summary>
     private void OpenPIConnection()
     {
-            m_connection = new PIConnection
-            {
-                ServerName = ServerName,
-                UserName = UserName,
-                Password = Password,
-                ConnectTimeout = ConnectTimeout
-            };
+        m_connection = new PIConnection
+        {
+            ServerName = ServerName,
+            UserName = UserName,
+            Password = Password,
+            ConnectTimeout = ConnectTimeout
+        };
+
+        string warningMessage = m_connection.Open();
 
-            m_connection.Open();
+        if (!string.IsNullOrEmpty(warningMessage))
+            OnStatusMessage(MessageLevel.Warning, warningMessage);
     }
 
     private IEnumerable<AFValue> ReadData(AFTime startTime, AFTime endTime, PIPointList points, int sampleRate)
@@ -241,15 +234,12 @@ private IEnumerable<AFValue> ReadData(AFTime startTime, AFTime endTime, PIPointL
             DataReadExceptionHandler = ex => OnProcessException(MessageLevel.Warning, ex)
         };
 
-        if (sampleRate <= 0)
-            return scanner.Read(PageFactor);
-        else
-            return scanner.ReadInterpolated(new AFTimeSpan(new TimeSpan(0,0,sampleRate)), PageFactor);
-     }
+        return sampleRate <= 0 ? scanner.Read(PageFactor) : scanner.ReadInterpolated(new AFTimeSpan(new TimeSpan(0, 0, sampleRate)), PageFactor);
+    }
 
 
     /// <summary>
-    /// Commnad that reads the PI Buffer for the specified time range and tags.
+    /// Command that reads the PI Buffer for the specified time range and tags.
     /// </summary>
     /// <param name="start"> The start Time of the requested data.</param>
     /// <param name="end">The end time for the data requested.</param>
@@ -262,7 +252,7 @@ public string ReadBuffer(DateTime start, DateTime end, string tags, int interpol
         if (end.Kind == DateTimeKind.Unspecified)
             end = DateTime.SpecifyKind(end, DateTimeKind.Utc);
 
-        string[] tagArray = tags.Split(new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries);
+        string[] tagArray = tags.Split([';'], StringSplitOptions.RemoveEmptyEntries);
 
         if (!Enabled || m_connection is null || tagArray.Length == 0)
         {
@@ -281,10 +271,9 @@ public string ReadBuffer(DateTime start, DateTime end, string tags, int interpol
 
         foreach (string tag in tagArray)
         {
-
             if (PIPoint.TryFindPIPoint(m_connection.Server, tag, out PIPoint point))
             {
-                tagList.Add(tag, new List<Tuple<long, double>>());
+                tagList.Add(tag, []);
                 points.Add(point);
             }
         }
@@ -308,24 +297,24 @@ public string ReadBuffer(DateTime start, DateTime end, string tags, int interpol
                 throw new NullReferenceException("PI data read returned a null value.");
 
             long timestamp = currentPoint.Timestamp.UtcTime.Ticks;
-            double Value = Convert.ToDouble(currentPoint.Value);
+            double value = Convert.ToDouble(currentPoint.Value);
 
             if (tagList.ContainsKey(currentPoint.PIPoint.Name))
             {
-                tagList[currentPoint.PIPoint.Name].Add(Tuple.Create(timestamp, Value));
+                tagList[currentPoint.PIPoint.Name].Add(Tuple.Create(timestamp, value));
             }
         }
 
         return string.Join(Environment.NewLine,
             tagList.Select(item => $"{item.Key}:{string.Join(";", item.Value.Select(v => $"{v.Item2},{v.Item1}"))}"));
     }
 
-    
+
     /// <inheritdoc/>
-    protected override void AttemptConnection() {}
+    protected override void AttemptConnection() { }
 
     /// <inheritdoc/>
-    protected override void AttemptDisconnection() {}
+    protected override void AttemptDisconnection() { }
 
     #endregion
 }

Source/Libraries/Adapters/PIAdapters/PIConnection.cs

@@ -142,8 +142,17 @@ protected virtual void Dispose(bool disposing)
     /// <summary>
     /// Attempts to open <see cref="PIConnection"/>.
     /// </summary>
-    public void Open()
+    /// <remarks>
+    /// Returns warning messages related to opening connection; otherwise, <c>null</c> if there are no warnings.
+    /// </remarks>
+    /// <exception cref="InvalidOperationException">
+    /// Connection is already open, <see cref="ServerName"/> is not defined, server not found in PI servers collection,
+    /// or failed to connect to PI server.
+    /// </exception>
+    public string Open()
     {
+        string warningMessage = null;
+
         if (m_connected || (Server is not null && Server.ConnectionInfo.IsConnected))
             throw new InvalidOperationException("OSI-PI server connection is already open.");
 
@@ -162,7 +171,12 @@ public void Open()
                 throw new InvalidOperationException("Server not found in the PI servers collection.");
 
             if (ConnectTimeout > 0)
-                Server.ConnectionInfo.ConnectionTimeOut = TimeSpan.FromMilliseconds(ConnectTimeout);
+            {
+                if (Server.Collective is null)
+                    Server.ConnectionInfo.ConnectionTimeOut = TimeSpan.FromMilliseconds(ConnectTimeout);
+                else
+                    warningMessage = "Cannot change connect timeout when connecting to PI collective";
+            }
 
             Server.ConnectChanged += PIConnection_ConnectChanged;
         }
@@ -181,6 +195,8 @@ public void Open()
         }
 
         m_connected = true;
+
+        return warningMessage;
     }
 
     /// <summary>

Source/Libraries/Adapters/PIAdapters/PIOutputAdapter.cs

@@ -1689,7 +1689,11 @@ protected override void AttemptConnection()
         };
 
         m_connection.Disconnected += Connection_Disconnected;
-        m_connection.Open();
+        
+        string warningMessage = m_connection.Open();
+
+        if (!string.IsNullOrEmpty(warningMessage))
+            OnStatusMessage(MessageLevel.Warning, warningMessage);
 
         m_mappedPIPoints.Clear();
 

Source/Libraries/Adapters/PIAdapters/PIPBInputAdapter.cs

@@ -402,7 +402,10 @@ protected override void AttemptConnection()
                 ConnectTimeout = ConnectTimeout
             };
 
-            m_connection.Open();
+            string warningMessage = m_connection.Open();
+
+            if (!string.IsNullOrEmpty(warningMessage))
+                OnStatusMessage(MessageLevel.Warning, warningMessage);
 
             // Start the data reader on its own thread so connection attempt can complete in a timely fashion...
             ThreadPool.QueueUserWorkItem(StartDataReader);

Source/Libraries/Adapters/PIAdapters/PIRTInputAdapter.cs

@@ -286,7 +286,11 @@ protected override void AttemptConnection()
         };
 
         m_connection.Disconnected += m_connection_Disconnected;
-        m_connection.Open();
+
+        string warningMessage = m_connection.Open();
+
+        if (!string.IsNullOrEmpty(warningMessage))
+            OnStatusMessage(MessageLevel.Warning, warningMessage);
 
         m_dataPipe = new PIDataPipe(AFDataPipeType.Snapshot);
         m_dataPipe.Subscribe(m_dataUpdateObserver);
@@ -465,7 +469,7 @@ private void m_dataUpdateObserver_DataUpdated(object sender, EventArgs<AFValue>
                 Timestamp = value.Timestamp.UtcTime
             };
 
-            OnNewMeasurements(new[] { measurement });
+            OnNewMeasurements([measurement]);
 
             m_lastReceivedTimestamp = measurement.Timestamp;
             m_lastReceivedValue = measurement.Value;