ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY > Class Template Reference

The First In First Out strategy is implemented wherein each item is ordered. More...

#include <Caching_Strategies_T.h>

Collaboration diagram for ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ATTRIBUTES CACHING_ATTRIBUTES

Public Member Functions

 ACE_FIFO_Caching_Strategy (void)
ATTRIBUTES attributes (void)
 Accessor method.
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)
 Notification for an item getting bound into the cache.
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)
 Notification for an item getting bound again into the cache.
CACHING_UTILITY & caching_utility (void)
 Purge the cache.
void dump (void) const
 Dumps the state of the object.

Private Attributes

ATTRIBUTES order_
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_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >

The First In First Out strategy is implemented wherein each item is ordered.

The order tag of each item is used to decide the item to be removed from the cache. The items with least order 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 392 of file Caching_Strategies_T.h.

Member Typedef Documentation

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

Definition at line 397 of file Caching_Strategies_T.h.

Constructor & Destructor Documentation

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::ACE_FIFO_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 44 of file Caching_Strategies_T.cpp.

00045   : order_ (0),
00046     purge_percent_ (10)
00047 {
00048 }

Member Function Documentation

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

Accessor method.

Definition at line 286 of file Caching_Strategies_T.inl.

References ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::order_.

00287 {
00288   return this->order_;
00289 }

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

Purge the cache.

Definition at line 355 of file Caching_Strategies_T.inl.

References ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::caching_utility_.

00356 {
00357   return this->caching_utility_;
00358 }

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

Dumps the state of the object.

Definition at line 361 of file Caching_Strategies_T.inl.

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

00362 {
00363 #if defined (ACE_HAS_DUMP)
00364   ACE_TRACE ("ACE_FIFO_Caching_Strategy::dump");
00365 
00366   ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this));
00367   ACE_DEBUG ((LM_DEBUG,  ACE_TEXT ("order_ = %d "), this->order_));
00368   ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP));
00369 #endif /* ACE_HAS_DUMP */
00370 }

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

Notification for an item getting bound into the cache.

Definition at line 304 of file Caching_Strategies_T.inl.

References ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::order_.

00306 {
00307   ACE_UNUSED_ARG (attr);
00308 
00309   if (result == 0)
00310     ++this->order_;
00311 
00312   return result;
00313 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE int ACE_FIFO_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 316 of file Caching_Strategies_T.inl.

00318 {
00319   ACE_UNUSED_ARG (attr);
00320 
00321   return result;
00322 }

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

Notification for an item getting bound again into the cache.

Definition at line 343 of file Caching_Strategies_T.inl.

References ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::order_.

00345 {
00346   ACE_UNUSED_ARG (attr);
00347 
00348   if (result == 0)
00349     ++this->order_;
00350 
00351   return result;
00352 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE int ACE_FIFO_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 334 of file Caching_Strategies_T.inl.

00336 {
00337   ACE_UNUSED_ARG (attr);
00338 
00339   return result;
00340 }

template<class ATTRIBUTES, class CACHING_UTILITY>
ACE_INLINE int ACE_FIFO_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 325 of file Caching_Strategies_T.inl.

00327 {
00328   ACE_UNUSED_ARG (attr);
00329 
00330   return result;
00331 }

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

Set the percentage of entries to purge.

Definition at line 298 of file Caching_Strategies_T.inl.

References ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::purge_percent_.

00299 {
00300   this->purge_percent_ = percentage;
00301 }

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

Get the percentage of entries to purge.

Definition at line 292 of file Caching_Strategies_T.inl.

References ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::purge_percent_.

00293 {
00294   return this->purge_percent_;
00295 }

Member Data Documentation

template<class ATTRIBUTES, class CACHING_UTILITY>
CACHING_UTILITY ACE_FIFO_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 463 of file Caching_Strategies_T.h.

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

template<class ATTRIBUTES, class CACHING_UTILITY>
ATTRIBUTES ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::order_ [private]

The order is the deciding factor for the item to be removed from the cache.

Definition at line 456 of file Caching_Strategies_T.h.

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

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

The level about which the purging will happen automagically.

Definition at line 459 of file Caching_Strategies_T.h.

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

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