summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorMark Michelson <mmichelson@digium.com>2013-10-18 15:29:15 +0000
committerMark Michelson <mmichelson@digium.com>2013-10-18 15:29:15 +0000
commit5bba145ee162569eac304c004cd77855ab98048c (patch)
tree29ea549c818903eafcec422bc5192f5c9ebd14a6 /include
parent32d758ed32ef1a5e452f4e7e6c1a4f5ceaa1c968 (diff)
Clarify in ast_bridge_destroy() about how departable channels must be handled.
........ Merged revisions 401212 from http://svn.asterisk.org/svn/asterisk/branches/12 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@401216 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include')
-rw-r--r--include/asterisk/bridge.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/include/asterisk/bridge.h b/include/asterisk/bridge.h
index 610e0f944..7d21aa76f 100644
--- a/include/asterisk/bridge.h
+++ b/include/asterisk/bridge.h
@@ -409,6 +409,12 @@ static inline void _ast_bridge_unlock(struct ast_bridge *bridge, const char *fil
* \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);