ACE  6.4.0
Public Types | Public Member Functions | Public Attributes | Protected Types | List of all members
ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES > Class Template Reference

Defines a abstraction which will purge entries from a map. The map considered is the ACE_Hash_Map_Manager_Ex. More...

#include <Hash_Cache_Map_Manager_T.h>

Inheritance diagram for ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >:
Inheritance graph
[legend]
Collaboration diagram for ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >:
Collaboration graph
[legend]

Public Types

typedef std::pair< VALUE, ATTRIBUTES > CACHE_VALUE
 
typedef ACE_Hash_Map_Manager_Ex< KEY, CACHE_VALUE, HASH_KEY, COMPARE_KEYS, ACE_Null_MutexHASH_MAP
 
typedef ACE_Hash_Map_Entry< KEY, CACHE_VALUECACHE_ENTRY
 
typedef KEY key_type
 
typedef VALUE mapped_type
 
- Public Types inherited from ACE_Cache_Map_Manager< KEY, VALUE, ACE_Hash_Map_Manager_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, ACE_Hash_Map_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, ACE_Hash_Map_Reverse_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, CACHING_STRATEGY, ATTRIBUTES >
typedef KEY key_type
 
typedef VALUE mapped_type
 
typedef ACE_Hash_Map_Manager_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutexmap_type
 
typedef CACHING_STRATEGY caching_strategy_type
 
typedef ACE_Hash_Map_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_MutexITERATOR_IMPLEMENTATION
 
typedef ACE_Hash_Map_Reverse_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_MutexREVERSE_ITERATOR_IMPLEMENTATION
 
typedef ACE_Cache_Map_Iterator< KEY, VALUE, ITERATOR_IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > ITERATOR
 
typedef ACE_Cache_Map_Reverse_Iterator< KEY, VALUE, REVERSE_ITERATOR_IMPLEMENTATION, CACHING_STRATEGY, ATTRIBUTES > REVERSE_ITERATOR
 
typedef ITERATOR iterator
 
typedef REVERSE_ITERATOR reverse_iterator
 
typedef std::pair< VALUE, ATTRIBUTES > CACHE_VALUE
 

Public Member Functions

 ACE_Hash_Cache_Map_Manager (CACHING_STRATEGY &caching_s, size_t size=ACE_DEFAULT_MAP_SIZE, ACE_Allocator *alloc=0)
 Initialize a <Hash_Cache_Map_Manager> with size entries. More...
 
 ~ACE_Hash_Cache_Map_Manager (void)
 
int bind (const KEY &key, const VALUE &value)
 
int bind (const KEY &key, const VALUE &value, CACHE_ENTRY *&entry)
 
int find (const KEY &key, VALUE &value)
 Loopkup entry<key,value> in the cache. More...
 
int find (const KEY &key)
 Is key in the cache? More...
 
int find (const KEY &key, CACHE_ENTRY *&entry)
 Obtain the entry when the find succeeds. More...
 
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 rebind (const KEY &key, const VALUE &value, CACHE_ENTRY *&entry)
 
int trybind (const KEY &key, VALUE &value)
 
int trybind (const KEY &key, VALUE &value, CACHE_ENTRY *&entry)
 
int unbind (const KEY &key)
 Remove key from the cache. More...
 
int unbind (const KEY &key, VALUE &value)
 
int unbind (CACHE_ENTRY *entry)
 Remove entry from map. More...
 
- Public Member Functions inherited from ACE_Cache_Map_Manager< KEY, VALUE, ACE_Hash_Map_Manager_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, ACE_Hash_Map_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, ACE_Hash_Map_Reverse_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, CACHING_STRATEGY, ATTRIBUTES >
 ACE_Cache_Map_Manager (CACHING_STRATEGY &caching_strategy, size_t size=ACE_DEFAULT_MAP_SIZE, ACE_Allocator *alloc=0)
 
virtual ~ACE_Cache_Map_Manager (void)
 
int open (size_t length=ACE_DEFAULT_MAP_SIZE, ACE_Allocator *alloc=0)
 Initialize a cache with size length. More...
 
int close (void)
 Close down a cache and release dynamically allocated resources. More...
 
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. More...
 
int unbind (const KEY &key, VALUE &value)
 
int purge (void)
 Remove entries from the cache depending upon the strategy. More...
 
size_t current_size (void) const
 Return the current size of the cache. More...
 
size_t total_size (void) const
 Return the total size of the cache. More...
 
void dump (void) const
 Dumps the state of the object. More...
 
ITERATOR begin (void)
 Return forward iterator. More...
 
ITERATOR end (void)
 
REVERSE_ITERATOR rbegin (void)
 Return reverse iterator. More...
 
REVERSE_ITERATOR rend (void)
 
ACE_Hash_Map_Manager_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex > & map (void)
 The map managed by the Cache_Map_Manager. More...
 
CACHING_STRATEGY & caching_strategy (void)
 The caching strategy used on the cache. More...
 

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 
- Public Attributes inherited from ACE_Cache_Map_Manager< KEY, VALUE, ACE_Hash_Map_Manager_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, ACE_Hash_Map_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, ACE_Hash_Map_Reverse_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, CACHING_STRATEGY, ATTRIBUTES >
 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 

Protected Types

typedef ACE_Cache_Map_Manager< KEY, VALUE, ACE_Hash_Map_Manager_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, ACE_Hash_Map_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, ACE_Hash_Map_Reverse_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, CACHING_STRATEGY, ATTRIBUTES > ACE_HCMM_BASE
 Base class. More...
 

Additional Inherited Members

- Protected Attributes inherited from ACE_Cache_Map_Manager< KEY, VALUE, ACE_Hash_Map_Manager_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, ACE_Hash_Map_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, ACE_Hash_Map_Reverse_Iterator_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex >, CACHING_STRATEGY, ATTRIBUTES >
ACE_Hash_Map_Manager_Ex< KEY, std::pair< VALUE, ATTRIBUTES >, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutexmap_
 The underlying map which needs to be cached. More...
 
CACHING_STRATEGY & caching_strategy_
 The strategy to be followed for caching entries in the map. More...
 

Detailed Description

template<class KEY, class VALUE, class HASH_KEY, class COMPARE_KEYS, class CACHING_STRATEGY, class ATTRIBUTES>
class ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >

Defines a abstraction which will purge entries from a map. The map considered is the ACE_Hash_Map_Manager_Ex.

The Hash_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. To tap the optimal methods like find(key,value,entry) present in the ACE_Hash_Map_Manager, Hash_Cache_Map_Manager provides extra functionality on top of the Cache_Map_Manager. No locking mechanism provided since locking at this level isn't efficient. Locking has to be provided by the application.

Member Typedef Documentation

template<class KEY, class VALUE, class HASH_KEY, class COMPARE_KEYS, class CACHING_STRATEGY, class ATTRIBUTES>
typedef ACE_Cache_Map_Manager<KEY, VALUE, ACE_Hash_Map_Manager_Ex<KEY, std::pair<VALUE, ATTRIBUTES>, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex>, ACE_Hash_Map_Iterator_Ex<KEY, std::pair<VALUE, ATTRIBUTES>, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex>, ACE_Hash_Map_Reverse_Iterator_Ex<KEY, std::pair<VALUE, ATTRIBUTES>, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex>, CACHING_STRATEGY, ATTRIBUTES> ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::ACE_HCMM_BASE
protected

Base class.

template<class KEY, class VALUE, class HASH_KEY, class COMPARE_KEYS, class CACHING_STRATEGY, class ATTRIBUTES>
typedef ACE_Hash_Map_Entry<KEY, CACHE_VALUE> ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::CACHE_ENTRY
template<class KEY, class VALUE, class HASH_KEY, class COMPARE_KEYS, class CACHING_STRATEGY, class ATTRIBUTES>
typedef std::pair<VALUE, ATTRIBUTES> ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, 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.

template<class KEY, class VALUE, class HASH_KEY, class COMPARE_KEYS, class CACHING_STRATEGY, class ATTRIBUTES>
typedef ACE_Hash_Map_Manager_Ex<KEY, CACHE_VALUE, HASH_KEY, COMPARE_KEYS, ACE_Null_Mutex> ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::HASH_MAP
template<class KEY, class VALUE, class HASH_KEY, class COMPARE_KEYS, class CACHING_STRATEGY, class ATTRIBUTES>
typedef KEY ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::key_type
template<class KEY, class VALUE, class HASH_KEY, class COMPARE_KEYS, class CACHING_STRATEGY, class ATTRIBUTES>
typedef VALUE ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::mapped_type

Constructor & Destructor Documentation

template<class KEY, class VALUE, class HASH_KEY, class COMPARE_KEYS, class CACHING_STRATEGY, class ATTRIBUTES>
class HASH_KEY class COMPARE_KEYS class CACHING_STRATEGY class ATTRIBUTES ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::ACE_Hash_Cache_Map_Manager ( CACHING_STRATEGY &  caching_s,
size_t  size = ACE_DEFAULT_MAP_SIZE,
ACE_Allocator alloc = 0 
)

Initialize a <Hash_Cache_Map_Manager> with size entries.

template<class KEY , class VALUE , class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::~ACE_Hash_Cache_Map_Manager ( void  )

Close down a <Cache_Map_Manager> and release dynamically allocated resources.

Member Function Documentation

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::bind ( const KEY &  key,
const VALUE &  value 
)
inline

Associate key with value. If key is already in the MAP 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.

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::bind ( const KEY &  key,
const VALUE &  value,
CACHE_ENTRY *&  entry 
)

Same as a normal bind, except the cache entry is also passed back to the caller. The entry in this case will either be the newly created entry, or the existing one.

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::find ( const KEY &  key,
VALUE &  value 
)

Loopkup entry<key,value> in the cache.

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::find ( const KEY &  key)

Is key in the cache?

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::find ( const KEY &  key,
CACHE_ENTRY *&  entry 
)

Obtain the entry when the find succeeds.

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::rebind ( const KEY &  key,
const VALUE &  value 
)
inline

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.

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::rebind ( const KEY &  key,
const VALUE &  value,
VALUE &  old_value 
)
inline

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.

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::rebind ( const KEY &  key,
const VALUE &  value,
KEY &  old_key,
VALUE &  old_value 
)
inline

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.

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::rebind ( const KEY &  key,
const VALUE &  value,
CACHE_ENTRY *&  entry 
)

Same as a normal rebind, except the cache entry is also passed back to the caller. The entry in this case will either be the newly created entry, or the existing one.

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::trybind ( const KEY &  key,
VALUE &  value 
)
inline

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.

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::trybind ( const KEY &  key,
VALUE &  value,
CACHE_ENTRY *&  entry 
)

Same as a normal trybind, except the cache entry is also passed back to the caller. The entry in this case will either be the newly created entry, or the existing one.

template<class KEY, class VALUE , class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::unbind ( const KEY &  key)
inline

Remove key from the cache.

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::unbind ( const KEY &  key,
VALUE &  value 
)
inline

Remove key from the cache, and return the value associated with key.

template<class KEY, class VALUE, class HASH_KEY , class COMPARE_KEYS , class CACHING_STRATEGY , class ATTRIBUTES >
int ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::unbind ( CACHE_ENTRY entry)

Remove entry from map.

Member Data Documentation

template<class KEY, class VALUE, class HASH_KEY, class COMPARE_KEYS, class CACHING_STRATEGY, class ATTRIBUTES>
ACE_Hash_Cache_Map_Manager< KEY, VALUE, HASH_KEY, COMPARE_KEYS, CACHING_STRATEGY, ATTRIBUTES >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.


The documentation for this class was generated from the following files: