Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

ACE_FIFO_Caching_Strategy 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:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ATTRIBUTES CACHING_ATTRIBUTES

Public Methods

 ACE_FIFO_Caching_Strategy (void)
ATTRIBUTES attributes (void)
 Accessor method. More...

double purge_percent (void)
 Get the percentage of entries to purge. More...

void purge_percent (double percentage)
 Set the percentage of entries to purge. More...

int notify_bind (int result, const ATTRIBUTES &attr)
 Notification for an item getting bound into the cache. More...

int notify_find (int result, ATTRIBUTES &attr)
 This method acts as a notification about the CONTAINERs find method call. More...

int notify_unbind (int result, const ATTRIBUTES &attr)
 This method acts as a notification about the CONTAINERs unbind method call. More...

int notify_trybind (int result, ATTRIBUTES &attr)
 This method acts as a notification about the CONTAINERs trybind method call. More...

int notify_rebind (int result, const ATTRIBUTES &attr)
 Notification for an item getting bound again into the cache. More...

CACHING_UTILITY & caching_utility (void)
 Purge the cache. More...

void dump (void) const
 Dumps the state of the object. More...


Private Attributes

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

double purge_percent_
 The level about which the purging will happen automagically. More...

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


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 390 of file Caching_Strategies_T.h.


Member Typedef Documentation

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

Definition at line 395 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 284 of file Caching_Strategies_T.i.

References order_.

00285 {
00286   return this->order_;
00287 }

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 353 of file Caching_Strategies_T.i.

References caching_utility_.

00354 {
00355   return this->caching_utility_;
00356 }

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 359 of file Caching_Strategies_T.i.

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

00360 {
00361   ACE_TRACE ("ACE_FIFO_Caching_Strategy::dump");
00362 
00363   ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this));
00364   ACE_DEBUG ((LM_DEBUG,  ACE_LIB_TEXT ("order_ = %d "), this->order_));
00365   ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP));
00366 }

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 302 of file Caching_Strategies_T.i.

References order_.

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

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 314 of file Caching_Strategies_T.i.

00316 {
00317   ACE_UNUSED_ARG (attr);
00318 
00319   return result;
00320 }

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 341 of file Caching_Strategies_T.i.

References order_.

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

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 332 of file Caching_Strategies_T.i.

00334 {
00335   ACE_UNUSED_ARG (attr);
00336 
00337   return result;
00338 }

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 323 of file Caching_Strategies_T.i.

00325 {
00326   ACE_UNUSED_ARG (attr);
00327 
00328   return result;
00329 }

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 296 of file Caching_Strategies_T.i.

References purge_percent_.

00297 {
00298   this->purge_percent_ = percentage;
00299 }

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 290 of file Caching_Strategies_T.i.

References purge_percent_.

00291 {
00292   return this->purge_percent_;
00293 }


Member Data Documentation

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

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

Definition at line 461 of file Caching_Strategies_T.h.

Referenced by caching_utility.

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

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

Definition at line 454 of file Caching_Strategies_T.h.

Referenced by attributes, notify_bind, and notify_rebind.

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

The level about which the purging will happen automagically.

Definition at line 457 of file Caching_Strategies_T.h.

Referenced by purge_percent.


The documentation for this class was generated from the following files:
Generated on Mon Jun 16 12:47:47 2003 for ACE by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002