summaryrefslogtreecommitdiff
path: root/include/asterisk/stasis.h
diff options
context:
space:
mode:
authorDavid M. Lee <dlee@digium.com>2013-06-05 21:14:46 +0000
committerDavid M. Lee <dlee@digium.com>2013-06-05 21:14:46 +0000
commit4cea90202090bf2db056de74b2ea4b5cacd40509 (patch)
tree7478bb8be51f6234dae351b04466c1a28a647492 /include/asterisk/stasis.h
parenta36d38ab388327d72fdf4d952415438bc4fa609f (diff)
Corrected comment on stasis_cache_get
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@390585 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/stasis.h')
-rw-r--r--include/asterisk/stasis.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/include/asterisk/stasis.h b/include/asterisk/stasis.h
index edb38ad1d..fdc629324 100644
--- a/include/asterisk/stasis.h
+++ b/include/asterisk/stasis.h
@@ -605,11 +605,13 @@ struct stasis_topic *stasis_caching_get_topic(struct stasis_caching_topic *cachi
/*!
* \brief Retrieve an item from the cache.
+ *
+ * The returned item is AO2 managed, so ao2_cleanup() when you're done with it.
+ *
* \param caching_topic The topic returned from stasis_caching_topic_create().
* \param type Type of message to retrieve.
* \param id Identity of the snapshot to retrieve.
- * \return Message from the cache. The cache still owns the message, so
- * ao2_ref() if you want to keep it.
+ * \return Message from the cache.
* \return \c NULL if message is not found.
* \since 12
*/