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


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/12@412439 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Kinsey Moore
2014-04-16 19:13:51 +00:00
parent 32cd970a21
commit 91e7c75848

View File

@@ -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.