ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY > Class Template Reference

Defines a Least Recently Used strategy which will decide on the item to be removed from the cache. More...

#include <Caching_Strategies_T.h>

Collaboration diagram for ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ATTRIBUTES CACHING_ATTRIBUTES

Public Member Functions

 ACE_LRU_Caching_Strategy (void)
ATTRIBUTES attributes (void)
 Accessor method for the timer attributes.
double purge_percent (void)
 Get the percentage of entries to purge.
void purge_percent (double percentage)
 Set the percentage of entries to purge.
int notify_bind (int result, const ATTRIBUTES &attr)
int notify_find (int result, ATTRIBUTES &attr)
int notify_unbind (int result, const ATTRIBUTES &attr)
int notify_trybind (int result, ATTRIBUTES &attr)
int notify_rebind (int result, const ATTRIBUTES &attr)
CACHING_UTILITY & caching_utility (void)
 Purge the cache.
void dump (void) const
 Dumps the state of the object.

Private Attributes

ATTRIBUTES timer_
double purge_percent_
 The level about which the purging will happen automagically.
CACHING_UTILITY caching_utility_

Detailed Description

template<class ATTRIBUTES, class CACHING_UTILITY>
class ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >

Defines a Least Recently Used strategy which will decide on the item to be removed from the cache.

This is a strategy which makes use of a virtual timer which is updated whenever an item is inserted or looked up in the container. When the need of purging entries arises, the items with the lowest timer values are removed. Explanation of the template parameter list: CONTAINER is any map with entries of type <KEY, VALUE>. The ATTRIBUTES are the deciding factor for purging of entries and should logically be included with the VALUE. Some ways of doing this are: As being a member of the VALUE or VALUE being ACE_Pair<x, ATTRIBUTES>. The CACHING_UTILITY is the class which can be plugged in and which decides the entries to purge.

Definition at line 199 of file Caching_Strategies_T.h.

Member Typedef Documentation

template<class ATTRIBUTES, class CACHING_UTILITY>
typedef ATTRIBUTES ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::CACHING_ATTRIBUTES

Definition at line 204 of file Caching_Strategies_T.h.

Constructor & Destructor Documentation

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::ACE_LRU_Caching_Strategy ( void   ) 

The <container> is the map in which the entries reside. The timer attribute is initialed to zero in this constructor. And the <purge_percent> field denotes the percentage of the entries in the cache which can be purged automagically and by default is set to 10%.

Definition at line 27 of file Caching_Strategies_T.cpp.

00028   : timer_ (0),
00029     purge_percent_ (10)
00030 {
00031 }

Member Function Documentation

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE ATTRIBUTES ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::attributes ( void   ) 

Accessor method for the timer attributes.

Definition at line 120 of file Caching_Strategies_T.inl.

References ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::timer_.

00121 {
00122   return this->timer_;
00123 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE CACHING_UTILITY & ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::caching_utility ( void   ) 

Purge the cache.

Definition at line 190 of file Caching_Strategies_T.inl.

References ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::caching_utility_.

00191 {
00192   return this->caching_utility_;
00193 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE void ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::dump ( void   )  const

Dumps the state of the object.

Definition at line 196 of file Caching_Strategies_T.inl.

References ACE_BEGIN_DUMP, ACE_DEBUG, ACE_END_DUMP, ACE_TEXT, ACE_TRACE, and LM_DEBUG.

00197 {
00198 #if defined (ACE_HAS_DUMP)
00199   ACE_TRACE ("ACE_LRU_Caching_Strategy::dump");
00200 
00201   ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this));
00202   ACE_DEBUG ((LM_DEBUG,  ACE_TEXT ("timer_ = %d "), this->timer_));
00203   ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP));
00204 #endif /* ACE_HAS_DUMP */
00205 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE int ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_bind ( int  result,
const ATTRIBUTES &  attr 
)

This method acts as a notification about the CONTAINERs bind method call.

Definition at line 138 of file Caching_Strategies_T.inl.

References ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::timer_.

00141 {
00142   if (result == 0)
00143     ++this->timer_;
00144 
00145   return result;
00146 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE int ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_find ( int  result,
ATTRIBUTES &  attr 
)

This method acts as a notification about the CONTAINERs find method call

Definition at line 149 of file Caching_Strategies_T.inl.

References ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::timer_.

00152 {
00153   if (result == 0)
00154     {
00155       attr = this->timer_;
00156       ++this->timer_;
00157     }
00158 
00159   return result;
00160 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE int ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_rebind ( int  result,
const ATTRIBUTES &  attr 
)

This method acts as a notification about the CONTAINERs rebind method call

Definition at line 179 of file Caching_Strategies_T.inl.

References ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::timer_.

00182 {
00183   if (result == 0)
00184     ++this->timer_;
00185 
00186   return result;
00187 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE int ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_trybind ( int  result,
ATTRIBUTES &  attr 
)

This method acts as a notification about the CONTAINERs trybind method call

Definition at line 171 of file Caching_Strategies_T.inl.

00174 {
00175   return result;
00176 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE int ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_unbind ( int  result,
const ATTRIBUTES &  attr 
)

This method acts as a notification about the CONTAINERs unbind method call

Definition at line 163 of file Caching_Strategies_T.inl.

00166 {
00167   return result;
00168 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE void ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::purge_percent ( double  percentage  ) 

Set the percentage of entries to purge.

Definition at line 132 of file Caching_Strategies_T.inl.

References ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::purge_percent_.

00133 {
00134   this->purge_percent_ = percentage;
00135 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE double ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::purge_percent ( void   ) 

Get the percentage of entries to purge.

Definition at line 126 of file Caching_Strategies_T.inl.

References ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::purge_percent_.

00127 {
00128   return this->purge_percent_;
00129 }

Member Data Documentation

template<class ATTRIBUTES, class CACHING_UTILITY>
CACHING_UTILITY ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::caching_utility_ [private]

This is the helper class which will decide and expunge entries from the cache.

Definition at line 273 of file Caching_Strategies_T.h.

Referenced by ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::caching_utility().

template<class ATTRIBUTES, class CACHING_UTILITY>
double ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::purge_percent_ [private]

The level about which the purging will happen automagically.

Definition at line 269 of file Caching_Strategies_T.h.

Referenced by ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::purge_percent().

template<class ATTRIBUTES, class CACHING_UTILITY>
ATTRIBUTES ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::timer_ [private]

This element is the one which is the deciding factor for purging of an ITEM.

Definition at line 266 of file Caching_Strategies_T.h.

Referenced by ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::attributes(), ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_bind(), ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_find(), and ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_rebind().

The documentation for this class was generated from the following files:
Generated on Tue Feb 2 17:35:16 2010 for ACE by  doxygen 1.4.7