Defines a abstraction that will purge entries from a map. More...
#include <Cache_Map_Manager_T.h>
Inheritance diagram for ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >:
Public Member Functions | |
| ACE_Cache_Map_Manager (CACHING_STRATEGY &caching_strategy, size_t size=ACE_DEFAULT_MAP_SIZE, ACE_Allocator *alloc=nullptr) | |
| virtual | ~ACE_Cache_Map_Manager () |
| int | open (size_t length=ACE_DEFAULT_MAP_SIZE, ACE_Allocator *alloc=nullptr) |
| Initialize a cache with size length. | |
| int | close () |
| Close down a cache and release dynamically allocated resources. | |
| int | bind (const KEY &key, const VALUE &value) |
| int | find (const KEY &key, VALUE &value) |
| int | find (const KEY &key) |
| int | rebind (const KEY &key, const VALUE &value) |
| int | rebind (const KEY &key, const VALUE &value, VALUE &old_value) |
| int | rebind (const KEY &key, const VALUE &value, KEY &old_key, VALUE &old_value) |
| int | trybind (const KEY &key, VALUE &value) |
| int | unbind (const KEY &key) |
| Remove key from the cache. | |
| int | unbind (const KEY &key, VALUE &value) |
| int | purge () |
| Remove entries from the cache depending upon the strategy. | |
| size_t | current_size () const |
| Return the current size of the cache. | |
| size_t | total_size () const |
| Return the total size of the cache. | |
| void | dump () const |
| Dumps the state of the object. | |
| ITERATOR | begin () |
| Return forward iterator. | |
| ITERATOR | end () |
| REVERSE_ITERATOR | rbegin () |
| Return reverse iterator. | |
| REVERSE_ITERATOR | rend () |
| CMAP_TYPE & | map () |
| The map managed by the Cache_Map_Manager. | |
| CACHING_STRATEGY & | caching_strategy () |
| The caching strategy used on the cache. | |
Public Attributes | |
| ACE_ALLOC_HOOK_DECLARE | |
| Declare the dynamic allocation hooks. | |
Protected Attributes | |
| CMAP_TYPE | map_ |
| The underlying map which needs to be cached. | |
| CACHING_STRATEGY & | caching_strategy_ |
| The strategy to be followed for caching entries in the map. | |
Private Member Functions | |
| void | operator= (const ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES > &)=delete |
| ACE_Cache_Map_Manager (const ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES > &)=delete | |
Detailed Description
template<class KEY, class VALUE, class CMAP_TYPE, class ITERATOR_IMPL, class REVERSE_ITERATOR_IMPL, class CACHING_STRATEGY, class ATTRIBUTES>
class ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >
class ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >
Defines a abstraction that will purge entries from a map.
The <ACE_Cache_Map_Manager> will manage the map it contains and provide purging on demand from the map. The strategy for caching is decided by the user and provided to the Cache Manager. The Cache Manager acts as a agent and communicates between the Map and the Strategy for purging entries from the map. No locking mechanism provided since locking at this level isn't efficient. Locking has to be provided by the application.
Member Typedef Documentation
◆ CACHE_VALUE
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| typedef std::pair<VALUE, ATTRIBUTES> ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::CACHE_VALUE |
The actual value mapped to the key in the map. The <attributes> are used by the strategy and is transparent to the user of this class.
◆ caching_strategy_type
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| typedef CACHING_STRATEGY ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::caching_strategy_type |
◆ ITERATOR
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| typedef ACE_Cache_Map_Iterator<KEY, VALUE, ITERATOR_IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::ITERATOR |
◆ iterator
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| typedef ITERATOR ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::iterator |
◆ ITERATOR_IMPLEMENTATION
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| typedef ITERATOR_IMPL ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::ITERATOR_IMPLEMENTATION |
◆ key_type
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| typedef KEY ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::key_type |
◆ map_type
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| typedef CMAP_TYPE ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::map_type |
◆ mapped_type
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| typedef VALUE ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::mapped_type |
◆ REVERSE_ITERATOR
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| typedef ACE_Cache_Map_Reverse_Iterator<KEY, VALUE, REVERSE_ITERATOR_IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES> ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::REVERSE_ITERATOR |
◆ reverse_iterator
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| typedef REVERSE_ITERATOR ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::reverse_iterator |
◆ REVERSE_ITERATOR_IMPLEMENTATION
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| typedef REVERSE_ITERATOR_IMPL ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::REVERSE_ITERATOR_IMPLEMENTATION |
Constructor & Destructor Documentation
◆ ACE_Cache_Map_Manager() [1/2]
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| class CMAP_TYPE class ITERATOR_IMPL class REVERSE_ITERATOR_IMPL class CACHING_STRATEGY class ATTRIBUTES ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::ACE_Cache_Map_Manager | ( | CACHING_STRATEGY & | caching_strategy, |
| size_t | size = ACE_DEFAULT_MAP_SIZE, | ||
| ACE_Allocator * | alloc = nullptr ) |
Initialize a <Cache_Map_Manager> with <caching_strategy> and size entries.
◆ ~ACE_Cache_Map_Manager()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
virtual |
Close down a <Cache_Map_Manager> and release dynamically allocated resources.
◆ ACE_Cache_Map_Manager() [2/2]
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
privatedelete |
Member Function Documentation
◆ begin()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
inline |
Return forward iterator.
◆ bind()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| int ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::bind | ( | const KEY & | key, |
| const VALUE & | value ) |
Associate key with value. If key is already in the CMAP_TYPE then the ENTRY is not changed. Returns 0 if a new entry is bound successfully, returns 1 if an attempt is made to bind an existing entry, and returns -1 if failures occur.
◆ caching_strategy()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
inline |
The caching strategy used on the cache.
◆ close()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| int ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::close | ( | ) |
Close down a cache and release dynamically allocated resources.
◆ current_size()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
inline |
Return the current size of the cache.
◆ dump()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| void ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::dump | ( | ) | const |
Dumps the state of the object.
◆ end()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
inline |
◆ find() [1/2]
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| int ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::find | ( | const KEY & | key | ) |
Lookup entry<key,value> in the cache. If it is not found, returns -1. If the key is located in the CMAP_TYPE object, the CACHING_STRATEGY is notified of it via notify_find (int result, ATTRIBUTES &attribute). If notify_find also returns 0 (success), then this function returns 0 (success).
◆ find() [2/2]
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| int ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::find | ( | const KEY & | key, |
| VALUE & | value ) |
Lookup entry<key,value> in the cache. If it is not found, returns -1. If the key is located in the CMAP_TYPE object, the CACHING_STRATEGY is notified of it via notify_find (int result, ATTRIBUTES &attribute). If notify_find also returns 0 (success), then this function returns 0 (success) and sets the cached value in value.
◆ map()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
inline |
The map managed by the Cache_Map_Manager.
◆ open()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| int ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::open | ( | size_t | length = ACE_DEFAULT_MAP_SIZE, |
| ACE_Allocator * | alloc = nullptr ) |
Initialize a cache with size length.
◆ operator=()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
privatedelete |
◆ purge()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
inline |
Remove entries from the cache depending upon the strategy.
◆ rbegin()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
inline |
Return reverse iterator.
◆ rebind() [1/3]
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| int ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::rebind | ( | const KEY & | key, |
| const VALUE & | value ) |
Reassociate the key with value. If the key already exists in the cache then returns 1, on a new bind returns 0 and returns -1 in case of any failures.
◆ rebind() [2/3]
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| int ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::rebind | ( | const KEY & | key, |
| const VALUE & | value, | ||
| KEY & | old_key, | ||
| VALUE & | old_value ) |
Reassociate key with value, storing the old key and value into the "out" parameters old_key and old_value. The function fails if key is not in the cache for caches that do not allow user specified keys. However, for caches that allow user specified keys, if the key is not in the cache, a new key / value association is created.
◆ rebind() [3/3]
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| int ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::rebind | ( | const KEY & | key, |
| const VALUE & | value, | ||
| VALUE & | old_value ) |
Reassociate key with value, storing the old value into the "out" parameter old_value. The function fails if key is not in the cache for caches that do not allow user specified keys. However, for caches that allow user specified keys, if the key is not in the cache, a new key / value association is created.
◆ rend()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
inline |
◆ total_size()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
inline |
Return the total size of the cache.
◆ trybind()
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| int ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::trybind | ( | const KEY & | key, |
| VALUE & | value ) |
Associate key with value if and only if key is not in the cache. If key is already in the cache, then the value parameter is overwritten with the existing value in the cache. Returns 0 if a new key / value association is created. Returns 1 if an attempt is made to bind an existing entry. This function fails for maps that do not allow user specified keys.
◆ unbind() [1/2]
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| int ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::unbind | ( | const KEY & | key | ) |
Remove key from the cache.
◆ unbind() [2/2]
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| int ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::unbind | ( | const KEY & | key, |
| VALUE & | value ) |
Remove key from the cache, and return the value associated with key.
Friends And Related Symbol Documentation
◆ ACE_Cache_Map_Iterator< KEY, VALUE, ITERATOR_IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
friend |
◆ ACE_Cache_Map_Reverse_Iterator< KEY, VALUE, REVERSE_ITERATOR_IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES >
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
friend |
Member Data Documentation
◆ ACE_ALLOC_HOOK_DECLARE
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
| ACE_Cache_Map_Manager< KEY, VALUE, CMAP_TYPE, ITERATOR_IMPL, REVERSE_ITERATOR_IMPL, CACHING_STRATEGY, ATTRIBUTES >::ACE_ALLOC_HOOK_DECLARE |
Declare the dynamic allocation hooks.
◆ caching_strategy_
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
protected |
The strategy to be followed for caching entries in the map.
◆ map_
template<class KEY , class VALUE , class CMAP_TYPE , class ITERATOR_IMPL , class REVERSE_ITERATOR_IMPL , class CACHING_STRATEGY , class ATTRIBUTES >
|
protected |
The underlying map which needs to be cached.
The documentation for this class was generated from the following files:
