summaryrefslogtreecommitdiff
path: root/include/asterisk/bridging_features.h
diff options
context:
space:
mode:
authorRichard Mudgett <rmudgett@digium.com>2013-06-20 17:21:40 +0000
committerRichard Mudgett <rmudgett@digium.com>2013-06-20 17:21:40 +0000
commitcd40e179a9bb01f10175ac3cecc633d631f69286 (patch)
treef8ff825633e0ee901f3f042544f98743cbdd682b /include/asterisk/bridging_features.h
parent33eb15a242694e47707b70065c86fad19035d5c8 (diff)
Fix potential bridge hook resource leak if the hook install fails.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@392335 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/bridging_features.h')
-rw-r--r--include/asterisk/bridging_features.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/include/asterisk/bridging_features.h b/include/asterisk/bridging_features.h
index 1ee13a46a..6399a22fc 100644
--- a/include/asterisk/bridging_features.h
+++ b/include/asterisk/bridging_features.h
@@ -390,7 +390,7 @@ int ast_bridge_interval_unregister(enum ast_bridge_builtin_interval interval);
* \param remove_flags Dictates what situations the hook should be removed.
*
* \retval 0 on success
- * \retval -1 on failure
+ * \retval -1 on failure (The caller must cleanup any hook_pvt resources.)
*
* Example usage:
*
@@ -420,7 +420,7 @@ int ast_bridge_join_hook(struct ast_bridge_features *features,
* \param remove_flags Dictates what situations the hook should be removed.
*
* \retval 0 on success
- * \retval -1 on failure
+ * \retval -1 on failure (The caller must cleanup any hook_pvt resources.)
*
* Example usage:
*
@@ -450,7 +450,7 @@ int ast_bridge_leave_hook(struct ast_bridge_features *features,
* \param remove_flags Dictates what situations the hook should be removed.
*
* \retval 0 on success
- * \retval -1 on failure
+ * \retval -1 on failure (The caller must cleanup any hook_pvt resources.)
*
* Example usage:
*
@@ -481,7 +481,7 @@ int ast_bridge_hangup_hook(struct ast_bridge_features *features,
* \param remove_flags Dictates what situations the hook should be removed.
*
* \retval 0 on success
- * \retval -1 on failure
+ * \retval -1 on failure (The caller must cleanup any hook_pvt resources.)
*
* Example usage:
*
@@ -503,7 +503,7 @@ int ast_bridge_dtmf_hook(struct ast_bridge_features *features,
enum ast_bridge_hook_remove_flags remove_flags);
/*!
- * \brief attach an interval hook to a bridge features structure
+ * \brief Attach an interval hook to a bridge features structure
*
* \param features Bridge features structure
* \param interval The interval that the hook should execute at in milliseconds
@@ -513,7 +513,7 @@ int ast_bridge_dtmf_hook(struct ast_bridge_features *features,
* \param remove_flags Dictates what situations the hook should be removed.
*
* \retval 0 on success
- * \retval -1 on failure
+ * \retval -1 on failure (The caller must cleanup any hook_pvt resources.)
*
* \code
* struct ast_bridge_features features;