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

ACE_Null_Caching_Utility Class Template Reference

Defines a dummy helper class for the Caching Strategies. More...

#include <Caching_Utility_T.h>

Collaboration diagram for ACE_Null_Caching_Utility:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ACE_Null_Cleanup_Strategy<
KEY, VALUE, CONTAINER > 
CLEANUP_STRATEGY
typedef ACE_Cleanup_Strategy<
KEY, VALUE, CONTAINER > 
CLEANUP_STRATEGY_BASE

Public Methods

 ACE_Null_Caching_Utility (ACE_Cleanup_Strategy< KEY, VALUE, CONTAINER > *cleanup_strategy=0, int delete_cleanup_strategy=0)
 Constructor. More...

 ~ACE_Null_Caching_Utility (void)
 Destructor. More...

int clear_cache (CONTAINER &container, double purge_percent)

Protected Methods

void minimum (CONTAINER &container, KEY *&key_to_remove, VALUE *&value_to_remove)

Protected Attributes

CLEANUP_STRATEGY_BASEcleanup_strategy_
 The cleanup strategy which can be used to destroy the entries of the container. More...

int delete_cleanup_strategy_
 Whether the cleanup_strategy should be destroyed or not. More...


Private Methods

void operator= (const ANUTIL< KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES > &)
 ANUTIL (const ANUTIL< KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES > &)

Detailed Description

template<class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
class ACE_Null_Caching_Utility< KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES >

Defines a dummy helper class for the Caching Strategies.

This class defines the methods commonly used by the different caching strategies. For instance: <clear_cache> method which decides and purges the entry from the container. Note: This class is be used with the Null_Caching_Strategy. The Cleanup_Strategy is the callback class to which the entries to be cleaned up will be delegated.

Definition at line 287 of file Caching_Utility_T.h.


Member Typedef Documentation

template<class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
typedef ACE_Null_Cleanup_Strategy<KEY, VALUE, CONTAINER> ACE_Null_Caching_Utility::CLEANUP_STRATEGY
 

Definition at line 291 of file Caching_Utility_T.h.

template<class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
typedef ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> ACE_Null_Caching_Utility::CLEANUP_STRATEGY_BASE
 

Definition at line 292 of file Caching_Utility_T.h.


Constructor & Destructor Documentation

template<class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
ACE_Null_Caching_Utility< KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES >::ACE_Null_Caching_Utility ACE_Cleanup_Strategy< KEY, VALUE, CONTAINER > *    cleanup_strategy = 0,
int    delete_cleanup_strategy = 0
 

Constructor.

Definition at line 462 of file Caching_Utility_T.cpp.

References ACE_NEW, and delete_cleanup_strategy_.

00464   : cleanup_strategy_ (cleanup_strategy),
00465     delete_cleanup_strategy_ (delete_cleanup_strategy)
00466 {
00467   if (cleanup_strategy == 0)
00468     {
00469       ACE_NEW (this->cleanup_strategy_,
00470                CLEANUP_STRATEGY);
00471       this->delete_cleanup_strategy_ = 1;
00472     }
00473 }

template<class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
ACE_Null_Caching_Utility< KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES >::~ACE_Null_Caching_Utility void   
 

Destructor.

Definition at line 476 of file Caching_Utility_T.cpp.

References cleanup_strategy_, and delete_cleanup_strategy_.

00477 {
00478   if (this->delete_cleanup_strategy_)
00479     delete this->cleanup_strategy_;
00480 }


Member Function Documentation

template<class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
ACE_Null_Caching_Utility< KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES >::ANUTIL const ANUTIL< KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES > &    [private]
 

template<class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
int ACE_Null_Caching_Utility< KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES >::clear_cache CONTAINER &    container,
double    purge_percent
 

Purge entries from the <container>. The Cleanup_Strategy will do the actual job of cleanup once the entries to be cleaned up are decided. Note: Here it is a no-op.

Definition at line 483 of file Caching_Utility_T.cpp.

00485 {
00486   ACE_UNUSED_ARG (container);
00487   ACE_UNUSED_ARG (purge_percent);
00488 
00489   return 0;
00490 }

template<class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
void ACE_Null_Caching_Utility< KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES >::minimum CONTAINER &    container,
KEY *&    key_to_remove,
VALUE *&    value_to_remove
[protected]
 

Find the entry with minimum caching attributes. This is handler specific since this utility is to be used very specifically for handler who have caching_attributes for server side acched connection management.Note: Here it is a no-op.

Definition at line 493 of file Caching_Utility_T.cpp.

00496 {
00497   ACE_UNUSED_ARG (container);
00498   ACE_UNUSED_ARG (key_to_remove);
00499   ACE_UNUSED_ARG (value_to_remove);
00500 }

template<class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
void ACE_Null_Caching_Utility< KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES >::operator= const ANUTIL< KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES > &    [private]
 


Member Data Documentation

template<class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
CLEANUP_STRATEGY_BASE* ACE_Null_Caching_Utility::cleanup_strategy_ [protected]
 

The cleanup strategy which can be used to destroy the entries of the container.

Definition at line 323 of file Caching_Utility_T.h.

Referenced by ~ACE_Null_Caching_Utility.

template<class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
int ACE_Null_Caching_Utility::delete_cleanup_strategy_ [protected]
 

Whether the cleanup_strategy should be destroyed or not.

Definition at line 326 of file Caching_Utility_T.h.

Referenced by ACE_Null_Caching_Utility, and ~ACE_Null_Caching_Utility.


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