Merge branch 'development' into feature/add-queues

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" />

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();
+        }
+    }
+}

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; }
+        }
+    }
+}

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; }
+    }
+}

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; }
+        }
+    }
+}

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);
+        }
+    }
+}

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">

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">