MemCore::CacheQueue Class Reference

A root object that holds a tail of cacheable objects. More...

#include </home/werner/origo/vish/memcore/CacheQueue.hpp>

List of all members.

Classes

• struct Iterator

  iterator class More...
  

Public Member Functions

• bool adjust (const CacheBase &theCache, memsize_t newCost, CacheQueue &TemporarilyUnreleasable, CacheQueue &PermanentlyUnreleasable)

  Try to adjust the cache by releasing objects from the queue until the new cost is achieved.
  

• Cacheable * back () const
• memsize_t compute_memsize () const

  Internal Debugging Function which computes the memsize by inspecting and summing up each object's contribution.
  

• void insertAsYoungest (const WeakPtr< Cacheable > &Ca)
• bool isAlreadyIncluded (const WeakPtr< Cacheable > &Ca) const
• int iterate (Iterator &It) const

  iterate over all elements here
  

• void list_info (FILE *where=stderr) const

  Show debug info.
  

• override memsize_t memsize () const

  The CacheQueue object will return the size occupied by all cached objects.
  

• int nEntries () const

  Count the number of entries here.
  

• Cacheable * oldest () const
• memsize_t purge ()

  Remove all objects from the Cache.
  

• void push_front (const WeakPtr< Cacheable > &Ca)

  Add Cacheable object to the front of the queue.
  

• void put_in_back (const WeakPtr< Cacheable > &Ca)
• void put_in_front (const WeakPtr< Cacheable > &Ca)

  Ensure the given object is in the front of the queue even if it is already contained somewhere else.
  

• Cacheable * youngest () const
• ~CacheQueue ()

  Destructor.
  

Friends

• class Cacheable

---

Detailed Description

A root object that holds a tail of cacheable objects.

---

Member Function Documentation

bool MemCore::CacheQueue::adjust	(	const CacheBase &	theCache,
		memsize_t	newCost,
		CacheQueue &	TemporarilyUnreleasable,
		CacheQueue &	PermanentlyUnreleasable
	)

Try to adjust the cache by releasing objects from the queue until the new cost is achieved.

Parameters:

theCache	The Cache management object
newCost	The memory occupation of the object that is supposed to be inserted soon.
TemporarilyUnreleasable	A CacheQueue where objects will be put that appear to be temporarily unreleasable.
PermanentlyUnreleasable	A CacheQueue for objects that seem to be unreleasable at all.

memsize_t MemCore::CacheQueue::compute_memsize

(

)

const

Internal Debugging Function which computes the memsize by inspecting and summing up each object's contribution.

The CacheQueue object will return the size occupied by all cached objects.

This function will be slow as compared to memsize(), and is only intended to be used occasionally for verifying that memsize() does return the correct value. How it actually should work is cacheable objects adding and subtracting themselves from the cachequeue overall memory size.

int MemCore::CacheQueue::nEntries

(

)

const

Count the number of entries here.

Never call this function, it is maximally slow.

---

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

• memcore/CacheQueue.hpp
• memcore/CacheQueue.cpp