#451 Fix namespace issues

essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/ComsMessage.cs

@@ -1,7 +1,7 @@
 using System;
 using PepperDash.Core;
 
-namespace PepperDash_Essentials_Core.Queues
+namespace PepperDash.Essentials.Core.Queues
 {
     /// <summary>
     /// IBasicCommunication Message for IQueue
@@ -62,6 +62,78 @@ namespace PepperDash_Essentials_Core.Queues
             }
         }
 
+        /// <summary>
+        /// Shows either the byte[] or string to be sent
+        /// </summary>
+        public override string ToString()
+        {
+            return _bytes != null ? _bytes.ToString() : _string;
+        }
+    }
+}
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    /// <summary>
+    /// IBasicCommunication Message for IQueue
+    /// </summary>
+    [Obsolete("Use PepperDash.Essentials.Core.Queues")]
+    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>

essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/GenericQueue.cs

@@ -3,7 +3,7 @@ using Crestron.SimplSharp;
 using Crestron.SimplSharpPro.CrestronThread;
 using PepperDash.Core;
 
-namespace PepperDash_Essentials_Core.Queues
+namespace PepperDash.Essentials.Core.Queues
 {
     /// <summary>
     /// Threadsafe processing of queued items with pacing if required
@@ -236,6 +236,250 @@ namespace PepperDash_Essentials_Core.Queues
             Dispose(false);
         }
 
+        /// <summary>
+        /// Key
+        /// </summary>
+        public string Key
+        {
+            get { return _key; }
+        }
+    }
+}
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    /// <summary>
+    /// Threadsafe processing of queued items with pacing if required
+    /// </summary>
+    [Obsolete("Use PepperDash.Essentials.Core.Queues")]
+    public class GenericQueue : IQueue<IQueueMessage>
+    {
+        private readonly string _key;
+        protected readonly CrestronQueue<IQueueMessage> _queue;
+        protected readonly Thread _worker;
+        protected readonly CEvent _waitHandle = new CEvent();
+
+        private bool _delayEnabled;
+        private int _delayTime;
+
+        private const Thread.eThreadPriority _defaultPriority = Thread.eThreadPriority.MediumPriority;
+
+        /// <summary>
+        /// If the instance has been disposed.
+        /// </summary>
+        public bool Disposed { get; private set; }
+
+        /// <summary>
+        /// Returns the capacity of the CrestronQueue (fixed Size property)
+        /// </summary>
+        public int QueueCapacity
+        {
+            get
+            {
+                return _queue.Size;
+            }
+        }
+
+        /// <summary>
+        /// Returns the number of elements currently in the CrestronQueue
+        /// </summary>    
+        public int QueueCount
+        {
+            get
+            {
+                return _queue.Count;
+            }
+        }
+
+        /// <summary>
+        /// Constructor with no thread priority
+        /// </summary>
+        /// <param name="key"></param>
+        public GenericQueue(string key)
+            : this(key, _defaultPriority, 0, 0)
+        {
+        }
+
+        /// <summary>
+        /// Constructor with queue size
+        /// </summary>
+        /// <param name="key"></param>
+        /// <param name="capacity">Fixed size for the queue to hold</param>
+        public GenericQueue(string key, int capacity)
+            : this(key, _defaultPriority, capacity, 0)
+        {
+        }
+
+        /// <summary>
+        /// Constructor for generic queue with no pacing
+        /// </summary>
+        /// <param name="key">Key</param>
+        /// <param name="pacing">Pacing in ms between actions</param>
+        public GenericQueue(int pacing, string key)
+            : this(key, _defaultPriority, 0, pacing)
+        {
+        }
+
+        /// <summary>
+        /// Constructor with pacing and capacity
+        /// </summary>
+        /// <param name="key"></param>
+        /// <param name="pacing"></param>
+        /// <param name="capacity"></param>
+        public GenericQueue(string key, int pacing, int capacity)
+            : this(key, _defaultPriority, capacity, pacing)
+        {
+        }
+
+        /// <summary>
+        /// Constructor with pacing and priority
+        /// </summary>
+        /// <param name="key"></param>
+        /// <param name="pacing"></param>
+        /// <param name="priority"></param>
+        public GenericQueue(string key, int pacing, Thread.eThreadPriority priority)
+            : this(key, priority, 0, pacing)
+        {
+        }
+
+        /// <summary>
+        /// Constructor with pacing, priority and capacity
+        /// </summary>
+        /// <param name="key"></param>
+        /// <param name="priority"></param>
+        /// <param name="capacity"></param>
+        public GenericQueue(string key, Thread.eThreadPriority priority, int capacity)
+            : this(key, priority, capacity, 0)
+        {
+        }
+
+        /// <summary>
+        /// Constructor with pacing, priority and capacity
+        /// </summary>
+        /// <param name="key"></param>
+        /// <param name="pacing"></param>
+        /// <param name="priority"></param>
+        /// <param name="capacity"></param>
+        public GenericQueue(string key, int pacing, Thread.eThreadPriority priority, int capacity)
+            : this(key, priority, capacity, pacing)
+        {
+        }
+
+        /// <summary>
+        /// Constructor for generic queue with no pacing
+        /// </summary>
+        /// <param name="key">Key</param>
+        /// <param name="priority"></param>
+        private GenericQueue(string key, Thread.eThreadPriority priority, int capacity, int pacing)
+        {
+            _key = key;
+            int cap = 25; // sets default
+            if (capacity > 0)
+            {
+                cap = capacity; // overrides default
+            }
+            _queue = new CrestronQueue<IQueueMessage>(cap);
+            _worker = new Thread(ProcessQueue, null, Thread.eThreadStartOptions.Running)
+            {
+                Priority = priority
+            };
+
+            SetDelayValues(pacing);
+        }
+
+        private void SetDelayValues(int pacing)
+        {
+            _delayEnabled = pacing > 0;
+            _delayTime = pacing;
+
+            CrestronEnvironment.ProgramStatusEventHandler += programEvent =>
+            {
+                if (programEvent != eProgramStatusEventType.Stopping)
+                    return;
+
+                Dispose();
+            };
+        }
+
+        /// <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)
+        {
+            while (true)
+            {
+                IQueueMessage 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());
+                        item.Dispatch();
+
+                        if (_delayEnabled)
+                            Thread.Sleep(_delayTime);
+                    }
+                    catch (Exception ex)
+                    {
+                        Debug.Console(0, this, Debug.ErrorLogLevel.Error, "Caught an exception in the Queue {0}\r{1}\r{2}", ex.Message, ex.InnerException, ex.StackTrace);
+                    }
+                }
+                else _waitHandle.Wait();
+            }
+
+            return null;
+        }
+
+        public void Enqueue(IQueueMessage 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>

essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/IQueue.cs

@@ -5,11 +5,21 @@ using System.Text;
 using Crestron.SimplSharp;
 using PepperDash.Core;
 
-namespace PepperDash_Essentials_Core.Queues
+namespace PepperDash.Essentials.Core.Queues
 {
     public interface IQueue<T> : IKeyed, IDisposable where T : class 
     {
         void Enqueue(T item);
         bool Disposed { get; }
     }
+}
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    [Obsolete("Use 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/IQueueMessage.cs

@@ -1,7 +1,18 @@
-namespace PepperDash_Essentials_Core.Queues
+using System;
+
+namespace PepperDash.Essentials.Core.Queues
 {
     public interface IQueueMessage
     {
         void Dispatch();
     }
+}
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    [Obsolete("Use PepperDash.Essentials.Core.Queues")]
+    public interface IQueueMessage
+    {
+        void Dispatch();
+    }
 }

essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/ProcessStringMessage.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace PepperDash_Essentials_Core.Queues
+namespace PepperDash.Essentials.Core.Queues
 {
     /// <summary>
     /// Message class for processing strings via an IQueue
@@ -32,6 +32,50 @@ namespace PepperDash_Essentials_Core.Queues
             _action(_message);
         }
 
+        /// <summary>
+        /// To string
+        /// </summary>
+        /// <returns>The current message</returns>
+        public override string ToString()
+        {
+            return _message ?? String.Empty;
+        }
+    }
+}
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    /// <summary>
+    /// Message class for processing strings via an IQueue
+    /// </summary>
+    [Obsolete("Use PepperDash.Essentials.Core.Queues")]
+    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>

essentials-framework/Essentials Core/PepperDashEssentialsBase/Queues/StringResponseProcessor.cs

@@ -2,7 +2,7 @@
 using Crestron.SimplSharp;
 using PepperDash.Core;
 
-namespace PepperDash_Essentials_Core.Queues
+namespace PepperDash.Essentials.Core.Queues
 {
     public sealed class StringResponseProcessor : IKeyed, IDisposable
     {
@@ -98,6 +98,110 @@ namespace PepperDash_Essentials_Core.Queues
         /// </summary>
         public bool Disposed { get; private set; }
 
+        ~StringResponseProcessor()
+        {
+            Dispose(false);
+        }
+    }
+}
+
+namespace PepperDash_Essentials_Core.Queues
+{
+    [Obsolete("Use PepperDash.Essentials.Core.Queues")]
+    public sealed class StringResponseProcessor : IKeyed, IDisposable
+    {
+        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)
+        {
+            _processStringAction = processStringAction;
+            _queue = new GenericQueue(key);
+
+            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(new ProcessStringMessage(args.Text, _processStringAction));
+        }
+
+        /// <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);