[asterisk-commits] mmichelson: branch 12 r401212 - /branches/12/include/asterisk/bridge.h

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Fri Oct 18 10:28:16 2013
New Revision: 401212

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=401212
Log:
Clarify in ast_bridge_destroy() about how departable channels must be handled.


Modified:
    branches/12/include/asterisk/bridge.h

Modified: branches/12/include/asterisk/bridge.h
URL: http://svnview.digium.com/svn/asterisk/branches/12/include/asterisk/bridge.h?view=diff&rev=401212&r1=401211&r2=401212
==============================================================================
--- branches/12/include/asterisk/bridge.h (original)
+++ branches/12/include/asterisk/bridge.h Fri Oct 18 10:28:16 2013
@@ -409,6 +409,12 @@
  * \endcode
  *
  * This destroys a bridge that was previously created.
+ *
+ * \note
+ * While this function will kick all channels out of the bridge, channels that
+ * were added to the bridge using ast_bridge_impart() with the flag
+ * AST_BRIDGE_IMPART_CHAN_DEPARTABLE set must have ast_bridge_depart() called
+ * on them before calling ast_bridge_destroy().
  */
 int ast_bridge_destroy(struct ast_bridge *bridge, int cause);