ACE: ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY > Class Template Reference

ACE 6.4.2

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

#include <Caching_Strategies_T.h>

Public Types
typedef ATTRIBUTES	CACHING_ATTRIBUTES

Public Member Functions
	ACE_LRU_Caching_Strategy (void)

ATTRIBUTES	attributes (void)
	Accessor method for the timer attributes. 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)

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. More...

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

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

Private Attributes
ATTRIBUTES	timer_

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

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 std::pair<x, ATTRIBUTES>. The CACHING_UTILITY is the class which can be plugged in and which decides the entries to purge.

Member Typedef Documentation

template<class ATTRIBUTES , class CACHING_UTILITY >

typedef ATTRIBUTES ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::CACHING_ATTRIBUTES

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%.

Member Function Documentation

template<class ATTRIBUTES , class CACHING_UTILITY >

ATTRIBUTES ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::attributes ( void )

inline

Accessor method for the timer attributes.

template<class ATTRIBUTES , class CACHING_UTILITY >

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

inline

Purge the cache.

template<class ATTRIBUTES , class CACHING_UTILITY >

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

inline

Dumps the state of the object.

template<class ATTRIBUTES , class CACHING_UTILITY >

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

inline

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

template<class ATTRIBUTES , class CACHING_UTILITY >

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

inline

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

template<class ATTRIBUTES , class CACHING_UTILITY >

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

inline

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

template<class ATTRIBUTES , class CACHING_UTILITY >

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

inline

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

template<class ATTRIBUTES , class CACHING_UTILITY >

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

inline

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

template<class ATTRIBUTES , class CACHING_UTILITY >

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

inline

Get the percentage of entries to purge.

template<class ATTRIBUTES , class CACHING_UTILITY >

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

inline

Set the percentage of entries to purge.

Member Data Documentation

template<class ATTRIBUTES , class CACHING_UTILITY >

ACE_LRU_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

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.

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.

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.

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