Merge pull request #72 from herman1vdb/master

Add some events for Asterisk 13 support

Asterisk.2013/Asterisk.NET/AsterNET.csproj

@@ -232,7 +232,11 @@
     <Compile Include="Manager\Event\BridgeEvent.cs" />
     <Compile Include="Manager\Event\ChannelReloadEvent.cs" />
     <Compile Include="Manager\Event\ChannelUpdateEvent.cs" />
+    <Compile Include="Manager\Event\DialEndEvent.cs" />
+    <Compile Include="Manager\Event\DialBeginEvent.cs" />
     <Compile Include="Manager\Event\FailedACLEvent.cs" />
+    <Compile Include="Manager\Event\QueueCallerJoinEvent.cs" />
+    <Compile Include="Manager\Event\QueueCallerLeaveEvent.cs" />
     <Compile Include="Manager\Event\MeetmeMuteEvent.cs" />
     <Compile Include="Manager\Event\DTMFEvent.cs" />
     <Compile Include="Manager\Event\FaxReceivedEvent.cs" />
@@ -247,6 +251,7 @@
     <Compile Include="Manager\Event\NewAccountCodeEvent.cs" />
     <Compile Include="Manager\Event\OriginateResponseEvent.cs" />
     <Compile Include="Manager\Event\PRIEvent.cs" />
+    <Compile Include="Manager\Event\QueueMemberPauseEvent.cs" />
     <Compile Include="Manager\Event\QueueMemberPenaltyEvent.cs" />
     <Compile Include="Manager\Event\RTPReceiverStatEvent.cs" />
     <Compile Include="Manager\Event\RTCPSentEvent.cs" />

Asterisk.2013/Asterisk.NET/Manager/Event/DialBeginEvent.cs

@@ -0,0 +1,16 @@
+namespace AsterNET.Manager.Event
+{
+    /// <summary>
+    /// A dial begin event is triggered whenever when a dial action has started.<br/>
+    /// </summary>
+    public class DialBeginEvent : DialEvent
+    {
+        /// <summary>
+        /// Creates a new DialBeginEvent.
+        /// </summary>
+        public DialBeginEvent(ManagerConnection source)
+			: base(source)
+		{
+        }
+    }
+}

Asterisk.2013/Asterisk.NET/Manager/Event/DialEndEvent.cs

@@ -0,0 +1,18 @@
+namespace AsterNET.Manager.Event
+{
+    /// <summary>
+    /// A dial begin event is triggered whenever when a dial action has completed.<br/>
+    /// </summary>
+	public class DialEndEvent : DialEvent
+    {
+        /// <summary>
+        /// Creates a new DialEndEvent.
+        /// </summary>
+        public DialEndEvent(ManagerConnection source)
+			: base(source)
+		{
+        }
+
+        public string Forward { get; set; }
+    }
+}

Asterisk.2013/Asterisk.NET/Manager/Event/ManagerEvent.cs

@@ -1,178 +1,139 @@
 using System;
-using System.Text;
 using System.Collections.Generic;
 
 namespace AsterNET.Manager.Event
 {
-	/// <summary>
+    /// <summary>
-	/// Abstract base class for all Events that can be received from the Asterisk server.<br/>
+    /// Abstract base class for all Events that can be received from the Asterisk server.<br/>
-	/// Events contain data pertaining to an event generated from within the Asterisk
+    /// Events contain data pertaining to an event generated from within the Asterisk
-	/// core or an extension module.<br/>
+    /// core or an extension module.<br/>
-	/// There is one conrete subclass of ManagerEvent per each supported Asterisk
+    /// There is one conrete subclass of ManagerEvent per each supported Asterisk Event.
-	/// Event.
+    /// 
-	/// </summary>
+    /// Channel / Privilege / UniqueId are not common to all events and should be moved to
-	public abstract class ManagerEvent : EventArgs, IParseSupport
+    /// derived event classes.
-	{
+    /// </summary>
-		private DateTime dateReceived;
+    public abstract class ManagerEvent : EventArgs, IParseSupport
-		private string privilege;
+    {
-		private string server;
+        #region Common Event Properties
-		private double timestamp;
 
-		private string uniqueId;
+        /// <summary>
-		private string channel;
+        /// Store all unknown (without setter) keys from manager event.<br/>
-		private ManagerConnection src;
+        /// Use in default Parse method <see cref="ManagerEvent.Parse(string, string)"/>
-		protected Dictionary<string, string> attributes;
+        /// </summary>
+        public Dictionary<string, string> Attributes { get; set; }
 
-		#region Constructors 
+        /// <summary>
-		public ManagerEvent()
+        /// Get/Set the name of the channel.
-		{
+        /// </summary>
-			this.dateReceived = DateTime.Now;
+        public string Channel { get; set; }
-		}
 
+        /// <summary>
+        /// Get/Set the point in time this event was received from the Asterisk server.<br/>
+        /// Pseudo events that are not directly received from the asterisk server
+        /// (for example ConnectEvent and DisconnectEvent) may return null.
+        /// </summary>
+        public DateTime DateReceived { get; set; }
+
+        /// <summary>
+        /// Get/Set the AMI authorization class of this event.<br/>
+        /// This is one or more of system, call, log, verbose, command, agent or user.
+        /// Multiple privileges are separated by comma.<br/>
+        /// Note: This property is not available from Asterisk 1.0 servers.
+        /// </summary>
+        public string Privilege { get; set; }
+
+        /// <summary>
+        /// Specify a server to which to send your commands (x.x.x.x or hostname).<br/>
+        /// This should match the server name specified in your config file's "host" entry.
+        /// If you do not specify a server, the proxy will pick the first one it finds -- fine in single-server configurations.
+        /// </summary>
+        public string Server { get; set; }
+
+        /// <summary>
+        /// The ManagerConnection the Event was sourced from.
+        /// </summary>
+        public ManagerConnection Source { get; set; }
+
+        /// <summary>
+        /// Returns the timestamp for this event.<br/>
+        /// The timestamp property is available in Asterisk since 1.4
+        /// if enabled in manager.conf by setting timestampevents = yes.
+        /// In contains the time the event was generated in seconds since the epoch.
+        /// </summary>
+        public double Timestamp { get; set; }
+
+        /// <summary>
+        /// Get/Set the unique id of the channel.
+        /// </summary>
+        public string UniqueId { get; set; }
+
+        #endregion
+
+        #region Constructors 
+        /// <summary>
+        /// Creates a new ManagerEvent. Source already set.
+        /// </summary>
+        public ManagerEvent()
+        {
+            this.DateReceived = DateTime.Now;
+        }
+
+        /// <summary>
+        /// Creates a new ManagerEvent
+        /// </summary>
+        /// <param name="source">ManagerConnection passed through in the event.</param>
 		public ManagerEvent(ManagerConnection source)
-			: this()
+            : this()
-		{
+        {
-			this.src = source as ManagerConnection;
+            this.Source = source;
-		}
+        }
-		#endregion
+        #endregion
 
+        #region Methods
 
-		#region Attributes 
+        /// <summary>
-		/// <summary>
+        /// Unknown properties parser
-		/// Store all unknown (without setter) keys from manager event.<br/>
+        /// </summary>
-		/// Use in default Parse method <see cref="Parse(string key, string value)"/>.
+        /// <param name="key">key name</param>
-		/// </summary>
+        /// <param name="value">key value</param>
-		public Dictionary<string, string> Attributes
+        /// <returns>true - value parsed, false - can't parse value</returns>
-		{
+        public virtual bool Parse(string key, string value)
-			get { return attributes; }
+        {
-		}
+            if (Attributes == null)
-		#endregion
+            {
+                Attributes = new Dictionary<string, string>();
+            }
 
-		#region Server 
+            if (Attributes.ContainsKey(key))
-		/// <summary>
+            {
-		/// Specify a server to which to send your commands (x.x.x.x or hostname).<br/>
+                Attributes[key] += string.Concat(Common.LINE_SEPARATOR, value); // Key already presents, add with delimiter
-		/// This should match the server name specified in your config file's "host" entry.
+            }
-		/// If you do not specify a server, the proxy will pick the first one it finds -- fine in single-server configurations.
+            else
-		/// </summary>
+            {
-		public string Server
+                Attributes.Add(key, value);
-		{
+            }
-			get { return server; }
-			set { server = value; }
-		}
-		#endregion
 
-		#region Timestamp 
+            return true;
-		/// <summary>
+        }
-		/// Returns the timestamp for this event.<br/>
-		/// The timestamp property is available in Asterisk since 1.4
-		/// if enabled in manager.conf by setting timestampevents = yes.
-		/// In contains the time the event was generated in seconds since the epoch.
-		/// </summary>
-		public double Timestamp
-		{
-			get { return this.timestamp; }
-			set { this.timestamp = value; }
-		}
-		#endregion
 
-		#region DateReceived
+        /// <summary>
-		/// <summary>
+        /// Unknown properties parser.
-		/// Get/Set the point in time this event was received from the Asterisk server.<br/>
+        /// </summary>
-		/// Pseudo events that are not directly received from the asterisk server
+        /// <param name="attributes">dictionary</param>
-		/// (for example ConnectEvent and DisconnectEvent) may return null.
+        /// <returns>updated dictionary</returns>
-		/// </summary>
+        public virtual Dictionary<string, string> ParseSpecial(Dictionary<string, string> attributes)
-		public DateTime DateReceived
+        {
-		{
+            return attributes;
-			get { return this.dateReceived; }
+        }
-			set { this.dateReceived = value; }
-		}
-		#endregion
 
-		#region Privilege 
+        /// <summary>
-		/// <summary>
+        ///  Convert all properties to string
-		/// Get/Set the AMI authorization class of this event.<br/>
+        /// </summary>
-		/// This is one or more of system, call, log, verbose, command, agent or user.
+        /// <returns>All event details and properties as a string</returns>
-		/// Multiple privileges are separated by comma.<br/>
-		/// Note: This property is not available from Asterisk 1.0 servers.
-		/// </summary>
-		public string Privilege
-		{
-			get { return privilege; }
-			set { this.privilege = value; }
-		}
-		#endregion
-
-		#region Source 
-		/// <summary>
-		/// Event source.
-		/// </summary>
-		public ManagerConnection Source 
-		{
-			get { return this.src; }
-		}
-		#endregion
-
-		#region UniqueId 
-		/// <summary>
-		/// Get/Set the unique id of the channel.
-		/// </summary>
-		public string UniqueId
-		{
-			get { return uniqueId; }
-			set { this.uniqueId = value; }
-		}
-		#endregion
-
-		#region Channel 
-		/// <summary>
-		/// Get/Set the name of the channel.
-		/// </summary>
-		public string Channel
-		{
-			get { return channel; }
-			set { this.channel = value; }
-		}
-		#endregion
-
-
-		#region Parse(string key, string value) 
-		/// <summary>
-		/// Unknown properties parser
-		/// </summary>
-		/// <param name="key">key name</param>
-		/// <param name="value">key value</param>
-		/// <returns>true - value parsed, false - can't parse value</returns>
-		public virtual bool Parse(string key, string value)
-		{
-			if (attributes == null)
-				attributes = new Dictionary<string, string>();
-
-			if (attributes.ContainsKey(key))
-				// Key already presents, add with delimiter
-				attributes[key] += string.Concat(Common.LINE_SEPARATOR, value);
-			else
-				attributes.Add(key, value);
-			return true;
-		}
-		#endregion
-
-		#region ParseSpecial(Dictionary<string, string> attributes)
-		/// <summary>
-		/// Unknown properties parser
-		/// </summary>
-		/// <param name="attributes">dictionary</param>
-		/// <returns>updated dictionary</returns>
-		public virtual Dictionary<string, string> ParseSpecial(Dictionary<string, string> attributes)
-		{
-			return attributes;
-		}
-		#endregion
-
-		#region ToString()
 		public override string ToString()
-		{
+        {
-			return Helper.ToString(this);
+            return Helper.ToString(this);
-		}
+        }
-		#endregion
+        #endregion
-	}
+    }
 }

Asterisk.2013/Asterisk.NET/Manager/Event/QueueCallerJoinEvent.cs

@@ -0,0 +1,15 @@
+namespace AsterNET.Manager.Event
+{
+    /// <summary>
+    /// A QueueCallerJoinEvent is triggered when a channel joins a queue.<br/>
+    /// </summary>
+    public class QueueCallerJoinEvent : QueueEvent
+    {
+        public string Position { get; set; }
+
+        public QueueCallerJoinEvent(ManagerConnection source)
+			: base(source)
+		{
+		}
+	}
+}

Asterisk.2013/Asterisk.NET/Manager/Event/QueueCallerLeaveEvent.cs

@@ -0,0 +1,15 @@
+namespace AsterNET.Manager.Event
+{
+    /// <summary>
+    /// A QueueCallerLeaveEvent is triggered when a channel leaves a queue.<br/>
+    /// </summary>
+    public class QueueCallerLeaveEvent : QueueEvent
+    {
+        public string Position { get; set; }
+
+        public QueueCallerLeaveEvent(ManagerConnection source)
+			: base(source)
+		{
+		}
+	}
+}

Asterisk.2013/Asterisk.NET/Manager/Event/QueueMemberPauseEvent.cs

@@ -0,0 +1,45 @@
+using System;
+
+namespace AsterNET.Manager.Event
+{
+    /// <summary>
+    /// Raised when a member is paused/unpaused in the queue.<br />
+    /// Available since Asterisk 12
+    /// </summary>
+    public class QueueMemberPauseEvent : AbstractQueueMemberEvent
+    {
+        /// <summary>
+        /// The name of the queue member.
+        /// </summary>
+        public string MemberName { get; set; }
+
+        /// <summary>
+        /// Get/Set if this queue member is paused (not accepting calls).<br/>
+        /// true if this member has been paused or
+        /// false if not.
+        /// </summary>
+        public bool Paused { get; set; }
+
+        /// <summary>
+        /// The reason a member was paused.
+        /// </summary>
+        public string Reason { get; set; }
+
+        /// <summary>
+        /// Set to 1 if member is in call. Set to 0 after LastCall time is updated.<br/>
+        /// Available since Asterisk 13
+        /// </summary>
+        public string InCall { get; set; }
+
+        /// <summary>
+        /// If set when paused, the reason the queue member was paused.<br/>
+        /// Available since Asterisk 13
+        /// </summary>
+        public string PausedReason { get; set; }
+
+		public QueueMemberPauseEvent(ManagerConnection source)
+			: base(source)
+		{
+		}
+	}
+}

Asterisk.2013/Asterisk.NET/Manager/Event/QueueMemberPausedEvent.cs

@@ -1,10 +1,16 @@
+using System;
+
 namespace AsterNET.Manager.Event
 {
-	/// <summary>
+    /// <summary>
-	/// A QueueMemberPausedEvent is triggered when a queue member is paused or unpaused.<br/>
+    /// A QueueMemberPausedEvent is triggered when a queue member is paused or unpaused.<br/>
-	/// It is implemented in apps/app_queue.c.<br/>
+    /// It is implemented in apps/app_queue.c.<br/>
-	/// Available since Asterisk 1.2
+    /// <para>
-	/// </summary>
+    /// Available since Asterisk 1.2.<br/>
+    /// Replaced by <see cref="QueueMemberPauseEvent"/> since Asterisk 12.<br/>
+    /// Removed since Asterisk 13.<br/>
+    /// </para>
+    /// </summary>
 	public class QueueMemberPausedEvent : AbstractQueueMemberEvent
 	{
 		private string memberName;

Asterisk.2013/Asterisk.NET/Manager/ManagerConnection.cs

@@ -95,15 +95,20 @@ namespace AsterNET.Manager
     public delegate void BridgeDestroyEventHandler(object sender, Event.BridgeDestroyEvent e);
     public delegate void BridgeEnterEventHandler(object sender, Event.BridgeEnterEvent e);
     public delegate void BridgeLeaveEventHandler(object sender, Event.BridgeLeaveEvent e);
+    public delegate void DialBeginEventHandler(object sender, Event.DialBeginEvent e);
+    public delegate void DialEndEventHandler(object sender, Event.DialEndEvent e);
+    public delegate void QueueCallerJoinEventHandler(object sender, Event.QueueCallerJoinEvent e);
+    public delegate void QueueCallerLeaveEventHandler(object sender, Event.QueueCallerLeaveEvent e);
+    public delegate void QueueMemberPauseEventHandler(object sender, Event.QueueMemberPauseEvent e);
 
 
 
-	#endregion
+    #endregion
 
-	/// <summary>
+    /// <summary>
-	/// Default implemention of the ManagerConnection interface.
+    /// Default implemention of the ManagerConnection interface.
-	/// </summary>
+    /// </summary>
-	public class ManagerConnection
+    public class ManagerConnection
 	{
 		#region Variables
 
@@ -486,11 +491,37 @@ namespace AsterNET.Manager
         public event BridgeEnterEventHandler BridgeEnter;
         public event BridgeLeaveEventHandler BridgeLeave;
 
-		#endregion
+        /// <summary>
+        /// Raised when a dial action has started.<br/>
+        /// </summary>
+        public event DialBeginEventHandler DialBegin;
 
-		#region Constructor - ManagerConnection()
+        /// <summary>
-		/// <summary> Creates a new instance.</summary>
+        /// Raised when a dial action has completed.<br/>
-		public ManagerConnection()
+        /// </summary>
+        public event DialEndEventHandler DialEnd;
+
+        /// <summary>
+        /// Raised when a caller joins a Queue.<br/>
+        /// </summary>
+        public event QueueCallerJoinEventHandler QueueCallerJoin;
+
+        /// <summary>
+        /// Raised when a caller leaves a Queue.<br/>
+        /// </summary>
+        public event QueueCallerLeaveEventHandler QueueCallerLeave;
+
+        /// <summary>
+        /// A QueueMemberPauseEvent is triggered when a queue member is paused or unpaused.<br />
+        /// Available since Asterisk 12
+        /// </summary>
+        public event QueueMemberPauseEventHandler QueueMemberPause;
+
+        #endregion
+
+        #region Constructor - ManagerConnection()
+        /// <summary> Creates a new instance.</summary>
+        public ManagerConnection()
 		{
 			callerThread = Thread.CurrentThread;
 
@@ -595,11 +626,15 @@ namespace AsterNET.Manager
             Helper.RegisterEventHandler(registeredEventHandlers, 90, typeof(BridgeEnterEvent));
             Helper.RegisterEventHandler(registeredEventHandlers, 91, typeof(BridgeLeaveEvent));
             Helper.RegisterEventHandler(registeredEventHandlers, 92, typeof(BlindTransferEvent));
+            Helper.RegisterEventHandler(registeredEventHandlers, 93, typeof(DialBeginEvent));
+            Helper.RegisterEventHandler(registeredEventHandlers, 94, typeof(DialEndEvent));
+            Helper.RegisterEventHandler(registeredEventHandlers, 95, typeof(QueueCallerJoinEvent));
+            Helper.RegisterEventHandler(registeredEventHandlers, 96, typeof(QueueCallerLeaveEvent));
+            Helper.RegisterEventHandler(registeredEventHandlers, 97, typeof(QueueMemberPauseEvent));
 
+            #endregion
 
-			#endregion
+            this.internalEvent += new ManagerEventHandler(internalEventHandler);
-
-			this.internalEvent += new ManagerEventHandler(internalEventHandler);
 		}
 		#endregion
 
@@ -1214,7 +1249,37 @@ namespace AsterNET.Manager
                             BlindTransfer(this, (BlindTransferEvent)e);
                         }
                         break;
-					default:
+                    case 93:
+                        if (DialBegin != null)
+                        {
+                            DialBegin(this, (DialBeginEvent)e);
+                        }
+                        break;
+                    case 94:
+                        if (DialEnd != null)
+                        {
+                            DialEnd(this, (DialEndEvent)e);
+                        }
+                        break;
+                    case 95:
+                        if (QueueCallerJoin != null)
+                        {
+                            QueueCallerJoin(this, (QueueCallerJoinEvent)e);
+                        }
+                        break;
+                    case 96:
+                        if (QueueCallerLeave != null)
+                        {
+                            QueueCallerLeave(this, (QueueCallerLeaveEvent)e);
+                        }
+                        break;
+                    case 97:
+                        if (QueueMemberPause != null)
+                        {
+                            QueueMemberPause(this, (QueueMemberPauseEvent)e);
+                        }
+                        break;
+                    default:
 						if (UnhandledEvent != null)
 							UnhandledEvent(this, e);
 						return;

Asterisk.2013/ChangeLog.txt

@@ -1,3 +1,9 @@
+21.09.2016	(herman1vdb)
+	Added events DialEndEvent, QueueCallerJoinEvent, QueueCallerLeaveEvent for further Asterisk 13 support
+	
+20.09.2016	(herman1vdb)
+	Added DialBeginEvent
+
 05.01.2015	(Skrusty)
 	Added a sandcastle documentation project to AsterNET. Initial draft includes CHM and HTML output based on AsterNET 1.0.0.