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

[SVN commits to the Digium repositories]

Author: mmichelson
Date: Wed Nov  4 11:00:15 2009
New Revision: 227650

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=227650
Log:
Add new function prototype.


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

Modified: team/group/CCSS/include/asterisk/ccss.h
URL: http://svnview.digium.com/svn/asterisk/team/group/CCSS/include/asterisk/ccss.h?view=diff&rev=227650&r1=227649&r2=227650
==============================================================================
--- team/group/CCSS/include/asterisk/ccss.h (original)
+++ team/group/CCSS/include/asterisk/ccss.h Wed Nov  4 11:00:15 2009
@@ -968,6 +968,28 @@
  */
 int ast_cc_failed(int core_id, const char * const debug);
 
+/*!
+ * \since 1.6.4
+ * \brief Indicate that a failure has occurred on a specific monitor
+ *
+ * If a monitor should detect that a failure has occurred when communicating
+ * with its endpoint, then ast_cc_monitor_failed should be called. The big
+ * difference between ast_cc_monitor_failed and ast_cc_failed is that ast_cc_failed
+ * indicates a global failure for a CC transaction, where as ast_cc_monitor_failed
+ * is localized to a particular monitor. When ast_cc_failed is called, the entire
+ * CC transaction is torn down. When ast_cc_monitor_failed is called, only the
+ * monitor on which the failure occurred is pruned from the tree of monitors.
+ *
+ * If there are no more devices left to monitor when this function is called,
+ * then the core will fail the CC transaction globally.
+ *
+ * \param core_id The core ID for the CC transaction
+ * \param monitor_name The name of the monitor on which the failure occurred
+ * \param debug A debug message to print to the CC log
+ * \return void
+ */
+void ast_cc_monitor_failed(int core_id, const char * const monitor_name, const char * const debug);
+
 /* END STATE CHANGE API */
 
 /* BEGIN STATUS REQUEST/RESPONSE API */