summaryrefslogtreecommitdiff
path: root/include/asterisk/stasis_app.h
diff options
context:
space:
mode:
authorKinsey Moore <kmoore@digium.com>2014-04-16 19:14:37 +0000
committerKinsey Moore <kmoore@digium.com>2014-04-16 19:14:37 +0000
commitb4210a0081f78130ef98d17fbca665298c25d7de (patch)
treeea668f9c845d585bb099ea9b89654d2fe5767f7c /include/asterisk/stasis_app.h
parent5b7a769fd8b02dcb1d6326ebbe1d4eafcdc75491 (diff)
Stasis: Add a usage note on stasis_app_get_bridge
This function returns an ast_bridge without a refcount bump and the caller must increment the count if it intends to hold the pointer. (closes issue ASTERISK-23588) Review: https://reviewboard.asterisk.org/r/3450/ Reported by: Matt Jordan ........ Merged revisions 412439 from http://svn.asterisk.org/svn/asterisk/branches/12 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@412440 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/stasis_app.h')
-rw-r--r--include/asterisk/stasis_app.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/asterisk/stasis_app.h b/include/asterisk/stasis_app.h
index 40ec208d6..8430cf330 100644
--- a/include/asterisk/stasis_app.h
+++ b/include/asterisk/stasis_app.h
@@ -675,6 +675,10 @@ int stasis_app_control_remove_channel_from_bridge(
* \since 12
* \brief Gets the bridge currently associated with a control object.
*
+ * \note If the bridge returned by this function is to be held for any
+ * length of time, its refcount should be incremented until the
+ * caller is finished with it.
+ *
* \param control Control object for the channel to query.
*
* \return Associated \ref ast_bridge.