[asterisk-commits] mmichelson: branch group/CCSS r214059 - /team/group/CCSS/apps/app_dial.c

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Tue Aug 25 13:09:44 2009
New Revision: 214059

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=214059
Log:
Add more comments.


Modified:
    team/group/CCSS/apps/app_dial.c

Modified: team/group/CCSS/apps/app_dial.c
URL: http://svn.asterisk.org/svn-view/asterisk/team/group/CCSS/apps/app_dial.c?view=diff&rev=214059&r1=214058&r2=214059
==============================================================================
--- team/group/CCSS/apps/app_dial.c (original)
+++ team/group/CCSS/apps/app_dial.c Tue Aug 25 13:09:44 2009
@@ -1648,6 +1648,10 @@
 	return 1; /* success */
 }
 
+/*!
+ * This counter is used for assigning unique ids
+ * to CC-enabled dialed interfaces.
+ */
 static int dial_cc_interface_counter;
 
 /*!
@@ -1660,10 +1664,19 @@
  */
 struct dial_cc_interfaces {
 	/*!
-	 * When a new Dial application is started, and the datastore
-	 * already exists on the channel, we can figure out where
-	 * in the existing interface tree to insert the new information
-	 * by using this number.
+	 * This value serves a dual-purpose. When dial starts, if the
+	 * dial_cc_interfaces datastore currently exists on the calling
+	 * channel, then the dial_parent_id will serve as a means of
+	 * letting the new extension ast_cc_interface we create know
+	 * who his parent is. This value will be the extension
+	 * ast_cc_interface that dialed the local channel that resulted
+	 * in the new Dial app being called.
+	 *
+	 * In addition, once an extension ast_cc_interface is created,
+	 * the dial_parent_id will be changed to the id of that newly
+	 * created interface. This way, device interfaces created from
+	 * receiving AST_CONTROL_CC frames can use this field to determine
+	 * who their parent extension interface should be.
 	 */
 	unsigned int dial_parent_id;
 	/*!