[asterisk-commits] kmoore: branch 12 r412439 - /branches/12/include/asterisk/stasis_app.h

[SVN commits to the Asterisk project]

Author: kmoore
Date: Wed Apr 16 14:13:51 2014
New Revision: 412439

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=412439
Log:
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

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

Modified: branches/12/include/asterisk/stasis_app.h
URL: http://svnview.digium.com/svn/asterisk/branches/12/include/asterisk/stasis_app.h?view=diff&rev=412439&r1=412438&r2=412439
==============================================================================
--- branches/12/include/asterisk/stasis_app.h (original)
+++ branches/12/include/asterisk/stasis_app.h Wed Apr 16 14:13:51 2014
@@ -675,6 +675,10 @@
  * \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.