From fdae50a9721f5ecd6432f96903d587c3a3afc870 Mon Sep 17 00:00:00 2001
From: Nick Genovese <ngenovese@pepperdash.com>
Date: Mon, 31 Aug 2020 15:34:12 -0400
Subject: [PATCH 1/2] Adds a generic queue and string/byte implementations. 
 Also adds a class that processes string responses from a IBasicCommunication
 or Gather

---
 .../PepperDash_Essentials_Core.csproj         |  11 +-
 .../Queues/BytesQueue.cs                      |  67 ++++++++
 .../Queues/GenericQueue.cs                    | 156 ++++++++++++++++++
 .../PepperDashEssentialsBase/Queues/IQueue.cs |  15 ++
 .../Queues/StringQueue.cs                     |  66 ++++++++
 .../Queues/StringResponseProcessor.cs         | 104 ++++++++++++
 .../PepperDash_Essentials_DM.csproj           |   6 +-
 .../Essentials Devices Common.csproj          |   6 +-
 8 files changed, 422 insertions(+), 9 deletions(-)
 create mode 100644 essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/BytesQueue.cs
 create mode 100644 essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/GenericQueue.cs
 create mode 100644 essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueue.cs
 create mode 100644 essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringQueue.cs
 create mode 100644 essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringResponseProcessor.cs

diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj b/essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj
index c31a46b8..fad95abf 100644
--- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj	
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj	
@@ -98,12 +98,12 @@
     </Reference>
     <Reference Include="SimplSharpCustomAttributesInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath>
+      <HintPath>..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpHelperInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath>
+      <HintPath>..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpNewtonsoft, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
@@ -113,7 +113,7 @@
     </Reference>
     <Reference Include="SimplSharpPro, Version=1.5.3.17, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath>
+      <HintPath>..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpReflectionInterface, Version=1.0.5583.25238, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
@@ -158,6 +158,7 @@
     <Compile Include="Bridges\JoinMaps\SetTopBoxControllerJoinMap.cs" />
     <Compile Include="Bridges\JoinMaps\StatusSignControllerJoinMap.cs" />
     <Compile Include="Bridges\JoinMaps\SystemMonitorJoinMap.cs" />
+    <Compile Include="Queues\BytesQueue.cs" />
     <Compile Include="Comm and IR\CecPortController.cs" />
     <Compile Include="Comm and IR\CommFactory.cs" />
     <Compile Include="Comm and IR\CommunicationExtras.cs" />
@@ -222,8 +223,10 @@
     <Compile Include="Fusion\FusionRviDataClasses.cs" />
     <Compile Include="Gateways\CenRfgwController.cs" />
     <Compile Include="Gateways\EssentialsRfGatewayConfig.cs" />
+    <Compile Include="Queues\GenericQueue.cs" />
     <Compile Include="Global\JobTimer.cs" />
     <Compile Include="Global\Scheduler.cs" />
+    <Compile Include="Queues\IQueue.cs" />
     <Compile Include="JoinMaps\JoinMapBase.cs" />
     <Compile Include="Lighting\Lighting Interfaces.cs" />
     <Compile Include="Lighting\LightingBase.cs" />
@@ -313,6 +316,8 @@
     <Compile Include="SmartObjects\SmartObjectDPad.cs" />
     <Compile Include="SmartObjects\SmartObjectHelperBase.cs" />
     <Compile Include="Routing\TieLine.cs" />
+    <Compile Include="Queues\StringQueue.cs" />
+    <Compile Include="Queues\StringResponseProcessor.cs" />
     <Compile Include="Timers\CountdownTimer.cs" />
     <Compile Include="Touchpanels\CrestronTouchpanelPropertiesConfig.cs" />
     <Compile Include="Touchpanels\Interfaces.cs" />
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/BytesQueue.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/BytesQueue.cs
new file mode 100644
index 00000000..aad96cf1
--- /dev/null
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/BytesQueue.cs	
@@ -0,0 +1,67 @@
+using System;
+using PepperDash.Core;
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    /// <summary>
+    /// Byte implementation of Action queue
+    /// </summary>
+    public class BytesQueue : IQueue<byte[]>
+    {
+        private readonly IQueue<byte[]> _queue;
+
+        /// <summary>
+        /// Constructor for BytesQueue
+        /// </summary>
+        /// <param name="key">Key</param>
+        /// <param name="processBytesAction">Action to process queued bytes</param>
+        public BytesQueue(string key, Action<byte[]> processBytesAction)
+        {
+            _queue = new GenericQueue<byte[]>(key, processBytesAction);
+        }
+
+        /// <summary>
+        /// Constructor for BytesQueue
+        /// </summary>
+        /// <param name="key">Key</param>
+        /// <param name="processBytesAction">Action to process queued bytes</param>
+        /// <param name="pacing">Delay in ms between actions being invoked</param>
+        public BytesQueue(string key, Action<byte[]> processBytesAction, int pacing)
+        {
+            _queue = new GenericQueue<byte[]>(key, processBytesAction, pacing);
+        }
+
+        /// <summary>
+        /// Enqueue a byte array to be processed
+        /// </summary>
+        /// <param name="item">Byte array to be processed</param>
+        public void Enqueue(byte[] item)
+        {
+            _queue.Enqueue(item);
+        }
+
+        /// <summary>
+        /// If the instance has been disposed
+        /// </summary>
+        public bool Disposed
+        {
+            get { return _queue.Disposed; }
+        }
+
+        /// <summary>
+        /// Key
+        /// </summary>
+        public string Key
+        {
+            get { return _queue.Key; }
+        }
+
+        /// <summary>
+        /// Disposes of resources
+        /// </summary>
+        public void Dispose()
+        {
+            _queue.Dispose();
+        }
+    }
+}
\ No newline at end of file
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/GenericQueue.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/GenericQueue.cs
new file mode 100644
index 00000000..6a06cab8
--- /dev/null
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/GenericQueue.cs	
@@ -0,0 +1,156 @@
+using System;
+using Crestron.SimplSharp;
+using Crestron.SimplSharpPro.CrestronThread;
+using PepperDash.Core;
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    /// <summary>
+    /// Threadsafe processing of queued items with pacing if required
+    /// </summary>
+    /// <typeparam name="T">Type of item to be processed</typeparam>
+    public class GenericQueue<T> : IQueue<T> where T : class
+    {
+        private readonly string _key;
+        protected readonly CrestronQueue<T> _queue;
+        protected readonly Thread _worker;
+        protected readonly CEvent _waitHandle = new CEvent();
+        
+        private readonly bool _delayEnabled;
+        private readonly int _delayTime;
+        
+        /// <summary>
+        /// If the instance has been disposed.
+        /// </summary>
+        public bool Disposed { get; private set; }
+
+        /// <summary>
+        /// Constructor for generic queue with no pacing
+        /// </summary>
+        /// <param name="key">Key</param>
+        /// <param name="processQueueAction">Action to process items in the queue</param>
+        public GenericQueue(string key, Action<T> processQueueAction)
+        {
+            _key = key;
+            _queue = new CrestronQueue<T>();
+            _worker = new Thread(ProcessQueue, processQueueAction, Thread.eThreadStartOptions.Running);
+
+            CrestronEnvironment.ProgramStatusEventHandler += programEvent =>
+            {
+                if (programEvent != eProgramStatusEventType.Stopping)
+                    return;
+
+                Dispose();
+            };
+        }
+
+        /// <summary>
+        /// Constructor for generic queue with no pacing
+        /// </summary>
+        /// <param name="key">Key</param>
+        /// <param name="processQueueAction">Action to process items in the queue</param>
+        /// <param name="pacing">Pacing in ms between actions</param>
+        public GenericQueue(string key, Action<T> processQueueAction, int pacing)
+            : this(key, processQueueAction)
+        {
+            _delayEnabled = pacing > 0;
+            _delayTime = pacing;
+        }
+
+        /// <summary>
+        /// Thread callback
+        /// </summary>
+        /// <param name="obj">The action used to process dequeued items</param>
+        /// <returns>Null when the thread is exited</returns>
+        private object ProcessQueue(object obj)
+        {
+            var action = obj as Action<T>;
+            if (action == null)
+                throw new ArgumentNullException("obj");
+
+            while (true)
+            {
+                T item = null;
+
+                if (_queue.Count > 0)
+                {
+                    item = _queue.Dequeue();
+                    if (item == null)
+                        break;
+                }
+                if (item != null)
+                {
+                    try
+                    {
+                        Debug.Console(2, this, "Processing queue item: '{0}'", item.ToString());
+                        action(item);
+
+                        if (_delayEnabled)
+                            Thread.Sleep(_delayTime);
+                    }
+                    catch (Exception ex)
+                    {
+                        Debug.ConsoleWithLog(0, this, "Caught an exception in the ComsQueue {0}\r{1}\r{2}", ex.Message, ex.InnerException, ex.StackTrace);
+                    }
+                }
+                else _waitHandle.Wait();
+            }
+
+            return null;
+        }
+
+        /// <summary>
+        /// Enqueues an item and processes the queue.  If 'null' is enqueued the thread will close and
+        /// the class must be reinstantiated.
+        /// </summary>
+        /// <param name="item">Item to be processed</param>
+        public virtual void Enqueue(T item)
+        {
+            _queue.Enqueue(item);
+            _waitHandle.Set();
+        }
+
+        /// <summary>
+        /// Disposes the thread and cleans up resources.  Thread cannot be restarted once
+        /// disposed.
+        /// </summary>
+        public void Dispose()
+        {
+            Dispose(true);
+            CrestronEnvironment.GC.SuppressFinalize(this);
+        }
+
+        /// <summary>
+        /// Actually does the disposing.  If you override this method, be sure to either call the base implementation 
+        /// or clean up all the resources yourself.
+        /// </summary>
+        /// <param name="disposing">set to true unless called from finalizer</param>
+        protected void Dispose(bool disposing)
+        {
+            if (Disposed)
+                return;
+
+            if (disposing)
+            {
+                Enqueue(null);
+                _worker.Join();
+                _waitHandle.Close();
+            }
+
+            Disposed = true;
+        }
+
+        ~GenericQueue()
+        {
+            Dispose(false);
+        }
+
+        /// <summary>
+        /// Key
+        /// </summary>
+        public string Key
+        {
+            get { return _key; }
+        }
+    }
+}
\ No newline at end of file
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueue.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueue.cs
new file mode 100644
index 00000000..9d69f7fa
--- /dev/null
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueue.cs	
@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using PepperDash.Core;
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    public interface IQueue<T> : IKeyed, IDisposable where T : class
+    {
+        void Enqueue(T item);
+        bool Disposed { get; }
+    }
+}
\ No newline at end of file
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringQueue.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringQueue.cs
new file mode 100644
index 00000000..2be49f74
--- /dev/null
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringQueue.cs	
@@ -0,0 +1,66 @@
+using System;
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    /// <summary>
+    /// String implementation of Action Queue
+    /// </summary>
+    public class StringQueue : IQueue<string>
+    {
+        private readonly IQueue<string> _queue;
+
+        /// <summary>
+        /// Constructor for BytesQueue
+        /// </summary>
+        /// <param name="key">Key</param>
+        /// <param name="processStringAction">Action to process queued strings</param>
+        public StringQueue(string key, Action<string> processStringAction)
+        {
+            _queue = new GenericQueue<string>(key, processStringAction);
+        }
+
+        /// <summary>
+        /// Constructor for StringQueue
+        /// </summary>
+        /// <param name="key">Key</param>
+        /// <param name="processStringAction">Action to process queued strings</param>
+        /// <param name="pacing">Delay in ms between actions being invoked</param>
+        public StringQueue(string key, Action<string> processStringAction, int pacing)
+        {
+            _queue = new GenericQueue<string>(key, processStringAction, pacing);
+        }
+
+        /// <summary>
+        /// Enqueue a byte array to be processed
+        /// </summary>
+        /// <param name="item">Byte array to be processed</param>
+        public void Enqueue(string item)
+        {
+            _queue.Enqueue(item);
+        }
+
+        /// <summary>
+        /// Key
+        /// </summary>
+        public string Key
+        {
+            get { return _queue.Key; }
+        }
+
+        /// <summary>
+        /// Disposes of resources
+        /// </summary>
+        public void Dispose()
+        {
+            _queue.Dispose();
+        }
+
+        /// <summary>
+        /// If the instance has been disposed
+        /// </summary>
+        public bool Disposed
+        {
+            get { return _queue.Disposed; }
+        }
+    }
+}
\ No newline at end of file
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringResponseProcessor.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringResponseProcessor.cs
new file mode 100644
index 00000000..a3c90689
--- /dev/null
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringResponseProcessor.cs	
@@ -0,0 +1,104 @@
+using System;
+using Crestron.SimplSharp;
+using PepperDash.Core;
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    public sealed class StringResponseProcessor : IKeyed, IDisposable
+    {
+        private readonly IQueue<string> _queue;
+        private readonly IBasicCommunication _coms;
+        private readonly CommunicationGather _gather;
+
+        private StringResponseProcessor(string key, Action<string> processStringAction)
+        {
+            _queue = new StringQueue(key, processStringAction);
+
+            CrestronEnvironment.ProgramStatusEventHandler += programEvent =>
+            {
+                if (programEvent != eProgramStatusEventType.Stopping)
+                    return;
+
+                Dispose();
+            };
+        }
+
+        /// <summary>
+        /// Constructor that builds an instance and subscribes to coms TextReceived for processing
+        /// </summary>
+        /// <param name="coms">Com port to process strings from</param>
+        /// <param name="processStringAction">Action to process the incoming strings</param>
+        public StringResponseProcessor(IBasicCommunication coms, Action<string> processStringAction)
+            : this(coms.Key, processStringAction)
+        {
+            _coms = coms;
+            coms.TextReceived += OnResponseReceived;
+        }
+
+        /// <summary>
+        /// Constructor that builds an instance and subscribes to gather Line Received for processing
+        /// </summary>
+        /// <param name="gather">Gather to process strings from</param>
+        /// <param name="processStringAction">Action to process the incoming strings</param>
+        public StringResponseProcessor(CommunicationGather gather, Action<string> processStringAction)
+            : this(gather.Port.Key, processStringAction)
+        {
+            _gather = gather;
+            gather.LineReceived += OnResponseReceived;
+        }
+
+        private void OnResponseReceived(object sender, GenericCommMethodReceiveTextArgs args)
+        {
+            _queue.Enqueue(args.Text);
+        }
+
+        /// <summary>
+        /// Key
+        /// </summary>
+        public string Key
+        {
+            get { return _queue.Key; }
+        }
+
+        /// <summary>
+        /// Disposes the instance and cleans up resources.
+        /// </summary>
+        public void Dispose()
+        {
+            Dispose(true);
+            CrestronEnvironment.GC.SuppressFinalize(this);
+        }
+
+        private void Dispose(bool disposing)
+        {
+            if (Disposed)
+                return;
+
+            if (disposing)
+            {
+                if (_coms != null)
+                    _coms.TextReceived -= OnResponseReceived;
+
+                if (_gather != null)
+                {
+                    _gather.LineReceived -= OnResponseReceived;
+                    _gather.Stop();
+                }
+
+                _queue.Dispose();
+            }
+
+            Disposed = true;
+        }
+
+        /// <summary>
+        /// If the instance has been disposed or not.  If it has, you can not use it anymore
+        /// </summary>
+        public bool Disposed { get; private set; }
+
+        ~StringResponseProcessor()
+        {
+            Dispose(false);
+        }
+    }
+}
\ No newline at end of file
diff --git a/essentials-framework/Essentials DM/Essentials_DM/PepperDash_Essentials_DM.csproj b/essentials-framework/Essentials DM/Essentials_DM/PepperDash_Essentials_DM.csproj
index a8843496..7c8b163a 100644
--- a/essentials-framework/Essentials DM/Essentials_DM/PepperDash_Essentials_DM.csproj	
+++ b/essentials-framework/Essentials DM/Essentials_DM/PepperDash_Essentials_DM.csproj	
@@ -68,12 +68,12 @@
     </Reference>
     <Reference Include="SimplSharpCustomAttributesInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath>
+      <HintPath>..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpHelperInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath>
+      <HintPath>..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpNewtonsoft, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
@@ -83,7 +83,7 @@
     </Reference>
     <Reference Include="SimplSharpPro, Version=1.5.3.17, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath>
+      <HintPath>..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpReflectionInterface, Version=1.0.5583.25238, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
diff --git a/essentials-framework/Essentials Devices Common/Essentials Devices Common/Essentials Devices Common.csproj b/essentials-framework/Essentials Devices Common/Essentials Devices Common/Essentials Devices Common.csproj
index 7c978bd8..22a1dc1d 100644
--- a/essentials-framework/Essentials Devices Common/Essentials Devices Common/Essentials Devices Common.csproj	
+++ b/essentials-framework/Essentials Devices Common/Essentials Devices Common/Essentials Devices Common.csproj	
@@ -77,12 +77,12 @@
     </Reference>
     <Reference Include="SimplSharpCustomAttributesInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath>
+      <HintPath>..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpHelperInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath>
+      <HintPath>..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpNewtonsoft, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
@@ -92,7 +92,7 @@
     </Reference>
     <Reference Include="SimplSharpPro, Version=1.5.3.17, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath>
+      <HintPath>..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpReflectionInterface, Version=1.0.5583.25238, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">

From b9fff952150ea86a5c0926ea024e32b25d7d0b33 Mon Sep 17 00:00:00 2001
From: Nick Genovese <ngenovese@pepperdash.com>
Date: Thu, 3 Sep 2020 10:57:06 -0400
Subject: [PATCH 2/2] added IQueueMessage and two implementations; GenericQueue
 now accepts type IQueueMessage

---
 .../Crestron/CrestronGenericBaseDevice.cs     |  2 +-
 .../PepperDash_Essentials_Core.csproj         |  5 +-
 .../Queues/BytesQueue.cs                      | 67 -----------------
 .../Queues/ComsMessage.cs                     | 73 +++++++++++++++++++
 .../Queues/GenericQueue.cs                    | 36 +++------
 .../PepperDashEssentialsBase/Queues/IQueue.cs |  2 +-
 .../Queues/IQueueMessage.cs                   |  7 ++
 .../Queues/ProcessStringMessage.cs            | 44 +++++++++++
 .../Queues/StringQueue.cs                     | 66 -----------------
 .../Queues/StringResponseProcessor.cs         |  8 +-
 10 files changed, 146 insertions(+), 164 deletions(-)
 delete mode 100644 essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/BytesQueue.cs
 create mode 100644 essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/ComsMessage.cs
 create mode 100644 essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueueMessage.cs
 create mode 100644 essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/ProcessStringMessage.cs
 delete mode 100644 essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringQueue.cs

diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Crestron/CrestronGenericBaseDevice.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Crestron/CrestronGenericBaseDevice.cs
index 9db81122..56b36791 100644
--- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Crestron/CrestronGenericBaseDevice.cs	
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Crestron/CrestronGenericBaseDevice.cs	
@@ -179,7 +179,7 @@ namespace PepperDash.Essentials.Core
 	{
 		public static eDeviceRegistrationUnRegistrationResponse RegisterWithLogging(this GenericBase device, string key)
 		{
-			var result = device.Register();
+		    var result = device.Register();
 			var level = result == eDeviceRegistrationUnRegistrationResponse.Success ?
 				Debug.ErrorLogLevel.Notice : Debug.ErrorLogLevel.Error;
 			Debug.Console(0, level, "Register device result: '{0}', type '{1}', result {2}", key, device, result);
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj b/essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj
index fad95abf..077d46fa 100644
--- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj	
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj	
@@ -158,7 +158,6 @@
     <Compile Include="Bridges\JoinMaps\SetTopBoxControllerJoinMap.cs" />
     <Compile Include="Bridges\JoinMaps\StatusSignControllerJoinMap.cs" />
     <Compile Include="Bridges\JoinMaps\SystemMonitorJoinMap.cs" />
-    <Compile Include="Queues\BytesQueue.cs" />
     <Compile Include="Comm and IR\CecPortController.cs" />
     <Compile Include="Comm and IR\CommFactory.cs" />
     <Compile Include="Comm and IR\CommunicationExtras.cs" />
@@ -223,6 +222,8 @@
     <Compile Include="Fusion\FusionRviDataClasses.cs" />
     <Compile Include="Gateways\CenRfgwController.cs" />
     <Compile Include="Gateways\EssentialsRfGatewayConfig.cs" />
+    <Compile Include="Queues\ComsMessage.cs" />
+    <Compile Include="Queues\ProcessStringMessage.cs" />
     <Compile Include="Queues\GenericQueue.cs" />
     <Compile Include="Global\JobTimer.cs" />
     <Compile Include="Global\Scheduler.cs" />
@@ -241,6 +242,7 @@
     <Compile Include="Plugins\PluginLoader.cs" />
     <Compile Include="Presets\PresetBase.cs" />
     <Compile Include="Plugins\IPluginDeviceFactory.cs" />
+    <Compile Include="Queues\IQueueMessage.cs" />
     <Compile Include="Ramps and Increments\ActionIncrementer.cs" />
     <Compile Include="Config\BasicConfig.cs" />
     <Compile Include="Config\ConfigPropertiesHelpers.cs" />
@@ -316,7 +318,6 @@
     <Compile Include="SmartObjects\SmartObjectDPad.cs" />
     <Compile Include="SmartObjects\SmartObjectHelperBase.cs" />
     <Compile Include="Routing\TieLine.cs" />
-    <Compile Include="Queues\StringQueue.cs" />
     <Compile Include="Queues\StringResponseProcessor.cs" />
     <Compile Include="Timers\CountdownTimer.cs" />
     <Compile Include="Touchpanels\CrestronTouchpanelPropertiesConfig.cs" />
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/BytesQueue.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/BytesQueue.cs
deleted file mode 100644
index aad96cf1..00000000
--- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/BytesQueue.cs	
+++ /dev/null
@@ -1,67 +0,0 @@
-using System;
-using PepperDash.Core;
-
-namespace PepperDash_Essentials_Core.Queues
-{
-    /// <summary>
-    /// Byte implementation of Action queue
-    /// </summary>
-    public class BytesQueue : IQueue<byte[]>
-    {
-        private readonly IQueue<byte[]> _queue;
-
-        /// <summary>
-        /// Constructor for BytesQueue
-        /// </summary>
-        /// <param name="key">Key</param>
-        /// <param name="processBytesAction">Action to process queued bytes</param>
-        public BytesQueue(string key, Action<byte[]> processBytesAction)
-        {
-            _queue = new GenericQueue<byte[]>(key, processBytesAction);
-        }
-
-        /// <summary>
-        /// Constructor for BytesQueue
-        /// </summary>
-        /// <param name="key">Key</param>
-        /// <param name="processBytesAction">Action to process queued bytes</param>
-        /// <param name="pacing">Delay in ms between actions being invoked</param>
-        public BytesQueue(string key, Action<byte[]> processBytesAction, int pacing)
-        {
-            _queue = new GenericQueue<byte[]>(key, processBytesAction, pacing);
-        }
-
-        /// <summary>
-        /// Enqueue a byte array to be processed
-        /// </summary>
-        /// <param name="item">Byte array to be processed</param>
-        public void Enqueue(byte[] item)
-        {
-            _queue.Enqueue(item);
-        }
-
-        /// <summary>
-        /// If the instance has been disposed
-        /// </summary>
-        public bool Disposed
-        {
-            get { return _queue.Disposed; }
-        }
-
-        /// <summary>
-        /// Key
-        /// </summary>
-        public string Key
-        {
-            get { return _queue.Key; }
-        }
-
-        /// <summary>
-        /// Disposes of resources
-        /// </summary>
-        public void Dispose()
-        {
-            _queue.Dispose();
-        }
-    }
-}
\ No newline at end of file
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/ComsMessage.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/ComsMessage.cs
new file mode 100644
index 00000000..92c97248
--- /dev/null
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/ComsMessage.cs	
@@ -0,0 +1,73 @@
+using System;
+using PepperDash.Core;
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    /// <summary>
+    /// IBasicCommunication Message for IQueue
+    /// </summary>
+    public class ComsMessage : IQueueMessage
+    {
+        private readonly byte[] _bytes;
+        private readonly IBasicCommunication _coms;
+        private readonly string _string;
+        private readonly bool _isByteMessage;
+
+        /// <summary>
+        /// Constructor for a string message
+        /// </summary>
+        /// <param name="coms">IBasicCommunication to send the message</param>
+        /// <param name="message">Message to send</param>
+        public ComsMessage(IBasicCommunication coms, string message)
+        {
+            Validate(coms, message);
+            _coms = coms;
+            _string = message;
+        }
+
+        /// <summary>
+        /// Constructor for a byte message
+        /// </summary>
+        /// <param name="coms">IBasicCommunication to send the message</param>
+        /// <param name="message">Message to send</param>
+        public ComsMessage(IBasicCommunication coms, byte[] message)
+        {
+            Validate(coms, message);
+            _coms = coms;
+            _bytes = message;
+            _isByteMessage = true;
+        }
+
+        private void Validate(IBasicCommunication coms, object message)
+        {
+            if (_coms == null)
+                throw new ArgumentNullException("coms");
+
+            if (message == null)
+                throw new ArgumentNullException("message");
+        }
+
+        /// <summary>
+        /// Dispatchs the string/byte[] to the IBasicCommunication specified
+        /// </summary>
+        public void Dispatch()
+        {
+            if (_isByteMessage)
+            {
+                _coms.SendBytes(_bytes);
+            }
+            else
+            {
+                _coms.SendText(_string);
+            }
+        }
+
+        /// <summary>
+        /// Shows either the byte[] or string to be sent
+        /// </summary>
+        public override string ToString()
+        {
+            return _bytes != null ? _bytes.ToString() : _string;
+        }
+    }
+}
\ No newline at end of file
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/GenericQueue.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/GenericQueue.cs
index 6a06cab8..1f27fe1e 100644
--- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/GenericQueue.cs	
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/GenericQueue.cs	
@@ -8,17 +8,16 @@ namespace PepperDash_Essentials_Core.Queues
     /// <summary>
     /// Threadsafe processing of queued items with pacing if required
     /// </summary>
-    /// <typeparam name="T">Type of item to be processed</typeparam>
-    public class GenericQueue<T> : IQueue<T> where T : class
+    public class GenericQueue : IQueue<IQueueMessage>
     {
         private readonly string _key;
-        protected readonly CrestronQueue<T> _queue;
+        protected readonly CrestronQueue<IQueueMessage> _queue;
         protected readonly Thread _worker;
         protected readonly CEvent _waitHandle = new CEvent();
         
         private readonly bool _delayEnabled;
         private readonly int _delayTime;
-        
+
         /// <summary>
         /// If the instance has been disposed.
         /// </summary>
@@ -28,12 +27,11 @@ namespace PepperDash_Essentials_Core.Queues
         /// Constructor for generic queue with no pacing
         /// </summary>
         /// <param name="key">Key</param>
-        /// <param name="processQueueAction">Action to process items in the queue</param>
-        public GenericQueue(string key, Action<T> processQueueAction)
+        public GenericQueue(string key)
         {
             _key = key;
-            _queue = new CrestronQueue<T>();
-            _worker = new Thread(ProcessQueue, processQueueAction, Thread.eThreadStartOptions.Running);
+            _queue = new CrestronQueue<IQueueMessage>();
+            _worker = new Thread(ProcessQueue, null, Thread.eThreadStartOptions.Running);
 
             CrestronEnvironment.ProgramStatusEventHandler += programEvent =>
             {
@@ -48,10 +46,9 @@ namespace PepperDash_Essentials_Core.Queues
         /// Constructor for generic queue with no pacing
         /// </summary>
         /// <param name="key">Key</param>
-        /// <param name="processQueueAction">Action to process items in the queue</param>
         /// <param name="pacing">Pacing in ms between actions</param>
-        public GenericQueue(string key, Action<T> processQueueAction, int pacing)
-            : this(key, processQueueAction)
+        public GenericQueue(string key, int pacing)
+            : this(key)
         {
             _delayEnabled = pacing > 0;
             _delayTime = pacing;
@@ -64,13 +61,9 @@ namespace PepperDash_Essentials_Core.Queues
         /// <returns>Null when the thread is exited</returns>
         private object ProcessQueue(object obj)
         {
-            var action = obj as Action<T>;
-            if (action == null)
-                throw new ArgumentNullException("obj");
-
             while (true)
             {
-                T item = null;
+                IQueueMessage item = null;
 
                 if (_queue.Count > 0)
                 {
@@ -83,14 +76,14 @@ namespace PepperDash_Essentials_Core.Queues
                     try
                     {
                         Debug.Console(2, this, "Processing queue item: '{0}'", item.ToString());
-                        action(item);
+                        item.Dispatch();
 
                         if (_delayEnabled)
                             Thread.Sleep(_delayTime);
                     }
                     catch (Exception ex)
                     {
-                        Debug.ConsoleWithLog(0, this, "Caught an exception in the ComsQueue {0}\r{1}\r{2}", ex.Message, ex.InnerException, ex.StackTrace);
+                        Debug.ConsoleWithLog(0, this, "Caught an exception in the Queue {0}\r{1}\r{2}", ex.Message, ex.InnerException, ex.StackTrace);
                     }
                 }
                 else _waitHandle.Wait();
@@ -99,12 +92,7 @@ namespace PepperDash_Essentials_Core.Queues
             return null;
         }
 
-        /// <summary>
-        /// Enqueues an item and processes the queue.  If 'null' is enqueued the thread will close and
-        /// the class must be reinstantiated.
-        /// </summary>
-        /// <param name="item">Item to be processed</param>
-        public virtual void Enqueue(T item)
+        public void Enqueue(IQueueMessage item)
         {
             _queue.Enqueue(item);
             _waitHandle.Set();
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueue.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueue.cs
index 9d69f7fa..852542d5 100644
--- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueue.cs	
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueue.cs	
@@ -7,7 +7,7 @@ using PepperDash.Core;
 
 namespace PepperDash_Essentials_Core.Queues
 {
-    public interface IQueue<T> : IKeyed, IDisposable where T : class
+    public interface IQueue<T> : IKeyed, IDisposable where T : class 
     {
         void Enqueue(T item);
         bool Disposed { get; }
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueueMessage.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueueMessage.cs
new file mode 100644
index 00000000..ee0d87d2
--- /dev/null
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueueMessage.cs	
@@ -0,0 +1,7 @@
+namespace PepperDash_Essentials_Core.Queues
+{
+    public interface IQueueMessage
+    {
+        void Dispatch();
+    }
+}
\ No newline at end of file
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/ProcessStringMessage.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/ProcessStringMessage.cs
new file mode 100644
index 00000000..a15f7231
--- /dev/null
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/ProcessStringMessage.cs	
@@ -0,0 +1,44 @@
+using System;
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    /// <summary>
+    /// Message class for processing strings via an IQueue
+    /// </summary>
+    public class ProcessStringMessage : IQueueMessage
+    {
+        private readonly Action<string> _action;
+        private readonly string _message;
+
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="message">Message to be processed</param>
+        /// <param name="action">Action to invoke on the message</param>
+        public ProcessStringMessage(string message, Action<string> action)
+        {
+            _message = message;
+            _action = action;
+        }
+
+        /// <summary>
+        /// Processes the string with the given action
+        /// </summary>
+        public void Dispatch()
+        {
+            if (_action == null || String.IsNullOrEmpty(_message))
+                return;
+
+            _action(_message);
+        }
+
+        /// <summary>
+        /// To string
+        /// </summary>
+        /// <returns>The current message</returns>
+        public override string ToString()
+        {
+            return _message ?? String.Empty;
+        }
+    }
+}
\ No newline at end of file
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringQueue.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringQueue.cs
deleted file mode 100644
index 2be49f74..00000000
--- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringQueue.cs	
+++ /dev/null
@@ -1,66 +0,0 @@
-using System;
-
-namespace PepperDash_Essentials_Core.Queues
-{
-    /// <summary>
-    /// String implementation of Action Queue
-    /// </summary>
-    public class StringQueue : IQueue<string>
-    {
-        private readonly IQueue<string> _queue;
-
-        /// <summary>
-        /// Constructor for BytesQueue
-        /// </summary>
-        /// <param name="key">Key</param>
-        /// <param name="processStringAction">Action to process queued strings</param>
-        public StringQueue(string key, Action<string> processStringAction)
-        {
-            _queue = new GenericQueue<string>(key, processStringAction);
-        }
-
-        /// <summary>
-        /// Constructor for StringQueue
-        /// </summary>
-        /// <param name="key">Key</param>
-        /// <param name="processStringAction">Action to process queued strings</param>
-        /// <param name="pacing">Delay in ms between actions being invoked</param>
-        public StringQueue(string key, Action<string> processStringAction, int pacing)
-        {
-            _queue = new GenericQueue<string>(key, processStringAction, pacing);
-        }
-
-        /// <summary>
-        /// Enqueue a byte array to be processed
-        /// </summary>
-        /// <param name="item">Byte array to be processed</param>
-        public void Enqueue(string item)
-        {
-            _queue.Enqueue(item);
-        }
-
-        /// <summary>
-        /// Key
-        /// </summary>
-        public string Key
-        {
-            get { return _queue.Key; }
-        }
-
-        /// <summary>
-        /// Disposes of resources
-        /// </summary>
-        public void Dispose()
-        {
-            _queue.Dispose();
-        }
-
-        /// <summary>
-        /// If the instance has been disposed
-        /// </summary>
-        public bool Disposed
-        {
-            get { return _queue.Disposed; }
-        }
-    }
-}
\ No newline at end of file
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringResponseProcessor.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringResponseProcessor.cs
index a3c90689..7f6477a3 100644
--- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringResponseProcessor.cs	
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringResponseProcessor.cs	
@@ -6,13 +6,15 @@ namespace PepperDash_Essentials_Core.Queues
 {
     public sealed class StringResponseProcessor : IKeyed, IDisposable
     {
-        private readonly IQueue<string> _queue;
+        private readonly Action<string> _processStringAction; 
+        private readonly IQueue<IQueueMessage> _queue;
         private readonly IBasicCommunication _coms;
         private readonly CommunicationGather _gather;
 
         private StringResponseProcessor(string key, Action<string> processStringAction)
         {
-            _queue = new StringQueue(key, processStringAction);
+            _processStringAction = processStringAction;
+            _queue = new GenericQueue(key);
 
             CrestronEnvironment.ProgramStatusEventHandler += programEvent =>
             {
@@ -49,7 +51,7 @@ namespace PepperDash_Essentials_Core.Queues
 
         private void OnResponseReceived(object sender, GenericCommMethodReceiveTextArgs args)
         {
-            _queue.Enqueue(args.Text);
+            _queue.Enqueue(new ProcessStringMessage(args.Text, _processStringAction));
         }
 
         /// <summary>