Split caching out from the stasis_caching_topic.

In working with res_stasis, I discovered a significant limitation to
the current structure of stasis_caching_topics: you cannot subscribe
to cache updates for a single channel/bridge/endpoint/etc.

To address this, this patch splits the cache away from the
stasis_caching_topic, making it a first class object. The stasis_cache
object is shared amongst individual stasis_caching_topics that are
created per channel/endpoint/etc. These are still forwarded to global
whatever_all_cached topics, so their use from most of the code does
not change.

In making these changes, I noticed that we frequently used a similar
pattern for bridges, endpoints and channels:

     single_topic  ---------------->  all_topic
           ^
           |
     single_topic_cached  ----+---->  all_topic_cached
                              |
                              +---->  cache

This pattern was extracted as the 'Stasis Caching Pattern', defined in
stasis_caching_pattern.h. This avoids a lot of duplicate code between
the different domain objects.

Since the cache is now disassociated from its upstream caching topics,
this also necessitated a change to how the 'guaranteed' flag worked
for retrieving from a cache. The code for handling the caching
guarantee was extracted into a 'stasis_topic_wait' function, which
works for any stasis_topic.

(closes issue ASTERISK-22002)
Review: https://reviewboard.asterisk.org/r/2672/


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@395954 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
David M. Lee
2013-08-01 13:49:34 +00:00
parent 5c13969469
commit e1b959ccbb
54 changed files with 1179 additions and 448 deletions

View File

@@ -106,6 +106,8 @@ struct ast_channel_blob {
*/
struct ast_multi_channel_blob;
struct stasis_cp_all *ast_channel_cache_all(void);
/*!
* \since 12
* \brief A topic which publishes the events for all channels.
@@ -120,16 +122,23 @@ struct stasis_topic *ast_channel_topic_all(void);
*
* \retval Topic for all channel events.
*/
struct stasis_caching_topic *ast_channel_topic_all_cached(void);
struct stasis_topic *ast_channel_topic_all_cached(void);
/*!
* \since 12
* \brief A caching topic which caches \ref ast_channel_snapshot messages from
* ast_channel_events_all(void) and indexes them by name.
* \brief Primary channel cache, indexed by Uniqueid.
*
* \retval Topic for all channel events.
* \retval Cache of \ref ast_channel_snapshot.
*/
struct stasis_caching_topic *ast_channel_topic_all_cached_by_name(void);
struct stasis_cache *ast_channel_cache(void);
/*!
* \since 12
* \brief Secondary channel cache, indexed by name.
*
* \retval Cache of \ref ast_channel_snapshot.
*/
struct stasis_cache *ast_channel_cache_by_name(void);
/*!
* \since 12
@@ -551,7 +560,9 @@ int ast_channel_snapshot_caller_id_equal(
/*!
* \brief Initialize the stasis channel topic and message types
* \return 0 on success
* \return Non-zero on error
*/
void ast_stasis_channels_init(void);
int ast_stasis_channels_init(void);
#endif /* STASIS_CHANNELS_H_ */