Search Toolkit Book for CCacheWithLock

#include <sra/data_loaders/csra/impl/csraloader_impl.hpp>

Inheritance diagram for CCacheWithLock< Key, Value, Less >:

Collaboration diagram for CCacheWithLock< Key, Value, Less >:

Classes
class	CLock

class	CSlot

Public Types
typedef Key	key_type

typedef Value	mapped_type

typedef Key	key_type

typedef Value	mapped_type

Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...

typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...

typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Public Member Functions
	CCacheWithLock (size_t size_limit=0)

CLock	get_lock (const key_type &key)

size_t	get_size_limit (void) const

void	set_size_limit (size_t size_limit)

	CCacheWithLock (size_t size_limit=0)

CLock	get_lock (const key_type &key)

size_t	get_size_limit (void) const

void	set_size_limit (size_t size_limit)

void	clear ()

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...

bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...

bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...

bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...

bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...

void	AddReference (void) const
	Add reference to object. More...

void	RemoveReference (void) const
	Remove reference to object. More...

void	ReleaseReference (void) const
	Remove reference without deleting object. More...

virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...

virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...

void *	operator new (size_t size)
	Define new operator for memory allocation. More...

void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...

void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...

void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...

void *	operator new (size_t size, void *place)
	Define new operator. More...

void	operator delete (void ptr, void place)
	Define delete operator. More...

void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...

void	operator delete (void ptr, CObjectMemoryPool place)
	Define delete operator. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)

virtual	~CDebugDumpable (void)

void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const

void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const

void	DumpToConsole (void) const

Protected Types
typedef Less	TLess

typedef map< key_type, CRef< CSlot >, TLess >	TMap

typedef TMap::iterator	TMapIterator

typedef TMap::const_iterator	TMapConstIterator

typedef list< TMapIterator >	TRemoveList

typedef TRemoveList::iterator	TRemoveListIterator

typedef Less	TLess

typedef map< key_type, CRef< CSlot >, TLess >	TMap

typedef TMap::iterator	TMapIterator

typedef TMap::const_iterator	TMapConstIterator

typedef list< TMapIterator >	TRemoveList

typedef TRemoveList::iterator	TRemoveListIterator

Protected Member Functions
void	Unlock (CSlot *slot)

void	x_GC ()

void	Unlock (CSlot *slot)

void	x_GC (size_t size)

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Protected Attributes
TMap	m_Map

size_t	m_SizeLimit

size_t	m_RemoveSize

TRemoveList	m_RemoveList

CMutex	m_Mutex

Additional Inherited Members
Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...

static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)

static EAllocFillMode	GetAllocFillMode (void)

static void	SetAllocFillMode (EAllocFillMode mode)

static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...

Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)

Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...

static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...

static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...

static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...

static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...

static const TCount	eCounterStateMask
	Valid object, and object in heap. More...

Detailed Description

template<class Key, class Value, class Less = less<Key>>
class CCacheWithLock< Key, Value, Less >

Definition at line 54 of file csraloader_impl.hpp.

Member Typedef Documentation

◆ key_type [1/2]

template<class Key , class Value , class Less = less<Key>>

typedef Key CCacheWithLock< Key, Value, Less >::key_type

Definition at line 57 of file csraloader_impl.hpp.

◆ key_type [2/2]

template<class Key , class Value , class Less = less<Key>>

typedef Key CCacheWithLock< Key, Value, Less >::key_type

Definition at line 44 of file cache_with_lock.hpp.

◆ mapped_type [1/2]

template<class Key , class Value , class Less = less<Key>>

typedef Value CCacheWithLock< Key, Value, Less >::mapped_type

Definition at line 58 of file csraloader_impl.hpp.

◆ mapped_type [2/2]

template<class Key , class Value , class Less = less<Key>>

typedef Value CCacheWithLock< Key, Value, Less >::mapped_type

Definition at line 45 of file cache_with_lock.hpp.

◆ TLess [1/2]

template<class Key , class Value , class Less = less<Key>>

typedef Less CCacheWithLock< Key, Value, Less >::TLess

protected

Definition at line 62 of file csraloader_impl.hpp.

◆ TLess [2/2]

template<class Key , class Value , class Less = less<Key>>

typedef Less CCacheWithLock< Key, Value, Less >::TLess

protected

Definition at line 49 of file cache_with_lock.hpp.

◆ TMap [1/2]

template<class Key , class Value , class Less = less<Key>>

typedef map<key_type, CRef<CSlot>, TLess> CCacheWithLock< Key, Value, Less >::TMap

protected

Definition at line 63 of file csraloader_impl.hpp.

◆ TMap [2/2]

template<class Key , class Value , class Less = less<Key>>

typedef map<key_type, CRef<CSlot>, TLess> CCacheWithLock< Key, Value, Less >::TMap

protected

Definition at line 50 of file cache_with_lock.hpp.

◆ TMapConstIterator [1/2]

template<class Key , class Value , class Less = less<Key>>

typedef TMap::const_iterator CCacheWithLock< Key, Value, Less >::TMapConstIterator

protected

Definition at line 65 of file csraloader_impl.hpp.

◆ TMapConstIterator [2/2]

template<class Key , class Value , class Less = less<Key>>

typedef TMap::const_iterator CCacheWithLock< Key, Value, Less >::TMapConstIterator

protected

Definition at line 52 of file cache_with_lock.hpp.

◆ TMapIterator [1/2]

template<class Key , class Value , class Less = less<Key>>

typedef TMap::iterator CCacheWithLock< Key, Value, Less >::TMapIterator

protected

Definition at line 64 of file csraloader_impl.hpp.

◆ TMapIterator [2/2]

template<class Key , class Value , class Less = less<Key>>

typedef TMap::iterator CCacheWithLock< Key, Value, Less >::TMapIterator

protected

Definition at line 51 of file cache_with_lock.hpp.

◆ TRemoveList [1/2]

template<class Key , class Value , class Less = less<Key>>

typedef list<TMapIterator> CCacheWithLock< Key, Value, Less >::TRemoveList

protected

Definition at line 66 of file csraloader_impl.hpp.

◆ TRemoveList [2/2]

template<class Key , class Value , class Less = less<Key>>

typedef list<TMapIterator> CCacheWithLock< Key, Value, Less >::TRemoveList

protected

Definition at line 53 of file cache_with_lock.hpp.

◆ TRemoveListIterator [1/2]

template<class Key , class Value , class Less = less<Key>>

typedef TRemoveList::iterator CCacheWithLock< Key, Value, Less >::TRemoveListIterator

protected

Definition at line 67 of file csraloader_impl.hpp.

◆ TRemoveListIterator [2/2]

template<class Key , class Value , class Less = less<Key>>

typedef TRemoveList::iterator CCacheWithLock< Key, Value, Less >::TRemoveListIterator

protected

Definition at line 54 of file cache_with_lock.hpp.

Constructor & Destructor Documentation

◆ CCacheWithLock() [1/2]

template<class Key , class Value , class Less = less<Key>>

CCacheWithLock< Key, Value, Less >::CCacheWithLock ( size_t size_limit = 0 )

inline

Definition at line 166 of file csraloader_impl.hpp.

◆ CCacheWithLock() [2/2]

template<class Key , class Value , class Less = less<Key>>

CCacheWithLock< Key, Value, Less >::CCacheWithLock ( size_t size_limit = 0 )

inline

Definition at line 155 of file cache_with_lock.hpp.

Member Function Documentation

◆ clear()

template<class Key , class Value , class Less = less<Key>>

void CCacheWithLock< Key, Value, Less >::clear ( void )

inline

Definition at line 190 of file cache_with_lock.hpp.

References CCacheWithLock< Key, Value, Less >::m_Mutex, and CCacheWithLock< Key, Value, Less >::x_GC().

◆ get_lock() [1/2]

template<class Key , class Value , class Less = less<Key>>

CLock CCacheWithLock< Key, Value, Less >::get_lock ( const key_type & key )

inline

Definition at line 172 of file csraloader_impl.hpp.

References _ASSERT, map_checker< Container >::end(), map_checker< Container >::insert(), ncbi::grid::netcache::search::fields::key, map_checker< Container >::lower_bound(), CCacheWithLock< Key, Value, Less >::m_Map, CCacheWithLock< Key, Value, Less >::m_Mutex, CCacheWithLock< Key, Value, Less >::m_RemoveList, CCacheWithLock< Key, Value, Less >::m_RemoveSize, and Ref().

◆ get_lock() [2/2]

template<class Key , class Value , class Less = less<Key>>

CLock CCacheWithLock< Key, Value, Less >::get_lock ( const key_type & key )

inline

Definition at line 161 of file cache_with_lock.hpp.

References _ASSERT, map_checker< Container >::end(), map_checker< Container >::insert(), ncbi::grid::netcache::search::fields::key, map_checker< Container >::lower_bound(), CCacheWithLock< Key, Value, Less >::m_Map, CCacheWithLock< Key, Value, Less >::m_Mutex, CCacheWithLock< Key, Value, Less >::m_RemoveList, CCacheWithLock< Key, Value, Less >::m_RemoveSize, and Ref().

◆ get_size_limit() [1/2]

template<class Key , class Value , class Less = less<Key>>

size_t CCacheWithLock< Key, Value, Less >::get_size_limit ( void ) const

inline

Definition at line 191 of file csraloader_impl.hpp.

References CCacheWithLock< Key, Value, Less >::m_SizeLimit.

◆ get_size_limit() [2/2]

template<class Key , class Value , class Less = less<Key>>

size_t CCacheWithLock< Key, Value, Less >::get_size_limit ( void ) const

inline

Definition at line 180 of file cache_with_lock.hpp.

References CCacheWithLock< Key, Value, Less >::m_SizeLimit.

◆ set_size_limit() [1/2]

template<class Key , class Value , class Less = less<Key>>

void CCacheWithLock< Key, Value, Less >::set_size_limit ( size_t size_limit )

inline

Definition at line 194 of file csraloader_impl.hpp.

References CCacheWithLock< Key, Value, Less >::m_Mutex, CCacheWithLock< Key, Value, Less >::m_SizeLimit, and CCacheWithLock< Key, Value, Less >::x_GC().

◆ set_size_limit() [2/2]

template<class Key , class Value , class Less = less<Key>>

void CCacheWithLock< Key, Value, Less >::set_size_limit ( size_t size_limit )

inline

Definition at line 183 of file cache_with_lock.hpp.

References CCacheWithLock< Key, Value, Less >::m_Mutex, CCacheWithLock< Key, Value, Less >::m_SizeLimit, and CCacheWithLock< Key, Value, Less >::x_GC().

◆ Unlock() [1/2]

template<class Key , class Value , class Less = less<Key>>

void CCacheWithLock< Key, Value, Less >::Unlock ( CSlot * slot )

inlineprotected

Definition at line 203 of file csraloader_impl.hpp.

References _ASSERT, CAtomicCounter::Add(), CCacheWithLock< Key, Value, Less >::CSlot::m_LockCounter, CCacheWithLock< Key, Value, Less >::CSlot::m_MapIter, CCacheWithLock< Key, Value, Less >::m_Mutex, CCacheWithLock< Key, Value, Less >::m_RemoveList, CCacheWithLock< Key, Value, Less >::CSlot::m_RemoveListIter, CCacheWithLock< Key, Value, Less >::m_RemoveSize, and CCacheWithLock< Key, Value, Less >::x_GC().

Referenced by CCacheWithLock< Key, Value, Less >::CLock::operator=(), and CCacheWithLock< Key, Value, Less >::CLock::Reset().

◆ Unlock() [2/2]

template<class Key , class Value , class Less = less<Key>>

void CCacheWithLock< Key, Value, Less >::Unlock ( CSlot * slot )

inlineprotected

Definition at line 196 of file cache_with_lock.hpp.

References _ASSERT, CAtomicCounter::Add(), CCacheWithLock< Key, Value, Less >::CSlot::m_LockCounter, CCacheWithLock< Key, Value, Less >::CSlot::m_MapIter, CCacheWithLock< Key, Value, Less >::m_Mutex, CCacheWithLock< Key, Value, Less >::m_RemoveList, CCacheWithLock< Key, Value, Less >::CSlot::m_RemoveListIter, CCacheWithLock< Key, Value, Less >::m_RemoveSize, CCacheWithLock< Key, Value, Less >::m_SizeLimit, and CCacheWithLock< Key, Value, Less >::x_GC().

◆ x_GC() [1/2]

template<class Key , class Value , class Less = less<Key>>

void CCacheWithLock< Key, Value, Less >::x_GC ( void )

inlineprotected

Definition at line 216 of file csraloader_impl.hpp.

References map_checker< Container >::erase(), CCacheWithLock< Key, Value, Less >::m_Map, CCacheWithLock< Key, Value, Less >::m_RemoveList, CCacheWithLock< Key, Value, Less >::m_RemoveSize, and CCacheWithLock< Key, Value, Less >::m_SizeLimit.

Referenced by CCacheWithLock< Key, Value, Less >::clear(), CCacheWithLock< Key, Value, Less >::set_size_limit(), and CCacheWithLock< Key, Value, Less >::Unlock().

◆ x_GC() [2/2]

template<class Key , class Value , class Less = less<Key>>

void CCacheWithLock< Key, Value, Less >::x_GC ( size_t size )

inlineprotected

Definition at line 209 of file cache_with_lock.hpp.

References map_checker< Container >::erase(), CCacheWithLock< Key, Value, Less >::m_Map, CCacheWithLock< Key, Value, Less >::m_RemoveList, CCacheWithLock< Key, Value, Less >::m_RemoveSize, and ncbi::grid::netcache::search::fields::size.

Member Data Documentation

◆ m_Map

template<class Key , class Value , class Less = less<Key>>

TMap CCacheWithLock< Key, Value, Less >::m_Map

protected

Definition at line 81 of file csraloader_impl.hpp.

Referenced by CCacheWithLock< Key, Value, Less >::get_lock(), and CCacheWithLock< Key, Value, Less >::x_GC().

◆ m_Mutex

template<class Key , class Value , class Less = less<Key>>

CMutex CCacheWithLock< Key, Value, Less >::m_Mutex

protected

Definition at line 85 of file csraloader_impl.hpp.

Referenced by CCacheWithLock< Key, Value, Less >::clear(), CCacheWithLock< Key, Value, Less >::get_lock(), CCacheWithLock< Key, Value, Less >::set_size_limit(), and CCacheWithLock< Key, Value, Less >::Unlock().

◆ m_RemoveList

template<class Key , class Value , class Less = less<Key>>

TRemoveList CCacheWithLock< Key, Value, Less >::m_RemoveList

protected

Definition at line 84 of file csraloader_impl.hpp.

Referenced by CCacheWithLock< Key, Value, Less >::get_lock(), CCacheWithLock< Key, Value, Less >::Unlock(), and CCacheWithLock< Key, Value, Less >::x_GC().

◆ m_RemoveSize

template<class Key , class Value , class Less = less<Key>>

size_t CCacheWithLock< Key, Value, Less >::m_RemoveSize

protected

Definition at line 83 of file csraloader_impl.hpp.

Referenced by CCacheWithLock< Key, Value, Less >::get_lock(), CCacheWithLock< Key, Value, Less >::Unlock(), and CCacheWithLock< Key, Value, Less >::x_GC().

◆ m_SizeLimit

template<class Key , class Value , class Less = less<Key>>

size_t CCacheWithLock< Key, Value, Less >::m_SizeLimit

protected

Definition at line 82 of file csraloader_impl.hpp.

Referenced by CCacheWithLock< Key, Value, Less >::get_size_limit(), CCacheWithLock< Key, Value, Less >::set_size_limit(), CCacheWithLock< Key, Value, Less >::Unlock(), and CCacheWithLock< Key, Value, Less >::x_GC().

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

include/sra/data_loaders/csra/impl/csraloader_impl.hpp
include/sra/readers/bam/cache_with_lock.hpp

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Key, class Value, class Less = less<Key>> class CCacheWithLock< Key, Value, Less >

Member Typedef Documentation

◆ key_type [1/2]

◆ key_type [2/2]

◆ mapped_type [1/2]

◆ mapped_type [2/2]

◆ TLess [1/2]

◆ TLess [2/2]

◆ TMap [1/2]

◆ TMap [2/2]

◆ TMapConstIterator [1/2]

◆ TMapConstIterator [2/2]

◆ TMapIterator [1/2]

◆ TMapIterator [2/2]

◆ TRemoveList [1/2]

◆ TRemoveList [2/2]

◆ TRemoveListIterator [1/2]

◆ TRemoveListIterator [2/2]

Constructor & Destructor Documentation

◆ CCacheWithLock() [1/2]

◆ CCacheWithLock() [2/2]

Member Function Documentation

◆ clear()

◆ get_lock() [1/2]

◆ get_lock() [2/2]

◆ get_size_limit() [1/2]

◆ get_size_limit() [2/2]

◆ set_size_limit() [1/2]

◆ set_size_limit() [2/2]

◆ Unlock() [1/2]

◆ Unlock() [2/2]

◆ x_GC() [1/2]

◆ x_GC() [2/2]

Member Data Documentation

◆ m_Map

◆ m_Mutex

◆ m_RemoveList

◆ m_RemoveSize

◆ m_SizeLimit

template<class Key, class Value, class Less = less<Key>>
class CCacheWithLock< Key, Value, Less >