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

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.

  : order_ (0),
    purge_percent_ (10)
{
}

Member Function Documentation

template<class ATTRIBUTES , class CACHING_UTILITY >

ATTRIBUTES ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::attributes ( void ) [inline]

Accessor method.

Definition at line 286 of file Caching_Strategies_T.inl.

{
  return this->order_;
}

template<class ATTRIBUTES , class CACHING_UTILITY >

CACHING_UTILITY & ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::caching_utility ( void ) [inline]

Purge the cache.

Definition at line 355 of file Caching_Strategies_T.inl.

{
  return this->caching_utility_;
}

template<class ATTRIBUTES , class CACHING_UTILITY >

void ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::dump ( void ) const [inline]

Dumps the state of the object.

Definition at line 361 of file Caching_Strategies_T.inl.

{
#if defined (ACE_HAS_DUMP)
  ACE_TRACE ("ACE_FIFO_Caching_Strategy::dump");

  ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this));
  ACE_DEBUG ((LM_DEBUG,  ACE_TEXT ("order_ = %d "), this->order_));
  ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP));
#endif /* ACE_HAS_DUMP */
}

template<class ATTRIBUTES , class CACHING_UTILITY >

int ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_bind	(	int	result,
		const ATTRIBUTES &	attr
	)			`[inline]`

Notification for an item getting bound into the cache.

Definition at line 304 of file Caching_Strategies_T.inl.

{
  ACE_UNUSED_ARG (attr);

  if (result == 0)
    ++this->order_;

  return result;
}

template<class ATTRIBUTES , class CACHING_UTILITY >

int ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_find	(	int	result,
		ATTRIBUTES &	attr
	)			`[inline]`

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

Definition at line 316 of file Caching_Strategies_T.inl.

{
  ACE_UNUSED_ARG (attr);

  return result;
}

template<class ATTRIBUTES , class CACHING_UTILITY >

int ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_rebind	(	int	result,
		const ATTRIBUTES &	attr
	)			`[inline]`

Notification for an item getting bound again into the cache.

Definition at line 343 of file Caching_Strategies_T.inl.

{
  ACE_UNUSED_ARG (attr);

  if (result == 0)
    ++this->order_;

  return result;
}

template<class ATTRIBUTES , class CACHING_UTILITY >

int ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::notify_trybind	(	int	result,
		ATTRIBUTES &	attr
	)			`[inline]`

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

Definition at line 334 of file Caching_Strategies_T.inl.

{
  ACE_UNUSED_ARG (attr);

  return result;
}

template<class ATTRIBUTES , class CACHING_UTILITY >

int ACE_FIFO_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

Definition at line 325 of file Caching_Strategies_T.inl.

{
  ACE_UNUSED_ARG (attr);

  return result;
}

template<class ATTRIBUTES , class CACHING_UTILITY >

double ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::purge_percent ( void ) [inline]

Get the percentage of entries to purge.

Definition at line 292 of file Caching_Strategies_T.inl.

{
  return this->purge_percent_;
}

template<class ATTRIBUTES , class CACHING_UTILITY >

void ACE_FIFO_Caching_Strategy< ATTRIBUTES, CACHING_UTILITY >::purge_percent ( double percentage ) [inline]

Set the percentage of entries to purge.

Definition at line 298 of file Caching_Strategies_T.inl.

{
  this->purge_percent_ = percentage;
}

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.

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.

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.

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

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines