[svn-commits] mmichelson: branch group/CCSS r212791 - /team/group/CCSS/include/asterisk/ccss.h

[SVN commits to the Digium repositories]

Author: mmichelson
Date: Tue Aug 18 12:26:46 2009
New Revision: 212791

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=212791
Log:
Another bit of progress. Nothing special though.


Modified:
    team/group/CCSS/include/asterisk/ccss.h

Modified: team/group/CCSS/include/asterisk/ccss.h
URL: http://svn.asterisk.org/svn-view/asterisk/team/group/CCSS/include/asterisk/ccss.h?view=diff&rev=212791&r1=212790&r2=212791
==============================================================================
--- team/group/CCSS/include/asterisk/ccss.h (original)
+++ team/group/CCSS/include/asterisk/ccss.h Tue Aug 18 12:26:46 2009
@@ -1,7 +1,7 @@
 /*
  * Asterisk -- An open source telephony toolkit.
  *
- * Copyright (C) 1999 - 2007, Digium, Inc.
+ * Copyright (C) 1999 - 2009, Digium, Inc.
  *
  * Mark Michelson <mmichelson at digium.com>
  *
@@ -173,9 +173,9 @@
 
 struct ast_ccss_extension_monitor_data {
 	/*! List of extensions which have failed outstanding calls to this extension.
-	 * I find it unlikely that this will ever be largely populated. If this list
-	 * is empty, it means that this extension monitor is the root of a tree and
-	 * should send any upstream requests to the CCSS core.
+	 * I find it unlikely that this will ever be largely populated. The root monitor
+	 * may also be the sole parent of an extension monitor, which makes this extension
+	 * monitor the "root" of a particular CC tree.
 	 */
 	AST_LIST_HEAD(,ast_ccss_monitor_link) parent_links;
 	/*! List of downstream device monitors. This list will have multiple elements
@@ -197,13 +197,16 @@
  * type can be retrieved through the monitor_data union.
  */
 struct ast_ccss_monitor {
+	/*! One of CCBS or CCNR. */
 	enum ast_ccss_monitor_type type;
+	/*! There are different types of monitors that each
+	 * need to do their own thing.
+	 */
 	union {
 		struct ast_ccss_device_monitor_data;
 		struct ast_ccss_extension_monitor_data;
 		struct ast_ccss_root_monitor_data;
 	} monitor_data;
-	/*! One of CCBS or CCNR. */
 	/*! The name of the device/extension being monitored */
 	const char *name
 	/*! The list of links to upstream extension monitors */
@@ -222,6 +225,7 @@
 	/* Suspend monitoring callback */
 	/* Status request callback */
 	/* Destroy callback (XXX handled in ao2 destructor?) */
+	/* Pass status upstream callback */
 };
 
 struct ast_ccss_agent {