NCBI C++ ToolKit
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
CVDBCacheWithExpiration::CSlot Class Reference

Search Toolkit Book for CVDBCacheWithExpiration::CSlot

#include <sra/readers/sra/vdbcache.hpp>

+ Inheritance diagram for CVDBCacheWithExpiration::CSlot:
+ Collaboration diagram for CVDBCacheWithExpiration::CSlot:

Public Types

typedef CMutex TSlotMutex
 
- 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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CSlot ()
 
virtual ~CSlot () override
 
TSlotMutexGetSlotMutex ()
 
template<class Object >
CRef< Object > GetObject () const
 
void SetObject (CObject *object)
 
void ResetObject ()
 
bool IsExpired (const CVDBCacheWithExpiration &cache, const string &acc_or_path) const
 
void UpdateExpiration (const CVDBCacheWithExpiration &cache, const string &acc_or_path)
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (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
 

Private Member Functions

 CSlot (const CSlot &)=delete
 
void operator= (const CSlot &)=delete
 

Private Attributes

TSlotMutex m_SlotMutex
 
CRef< CExpirationInfom_ExpirationInfo
 
CRef< CObjectm_Object
 

Friends

class CVDBCacheWithExpiration
 

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...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 92 of file vdbcache.hpp.

Member Typedef Documentation

◆ TSlotMutex

Definition at line 98 of file vdbcache.hpp.

Constructor & Destructor Documentation

◆ CSlot() [1/2]

CVDBCacheWithExpiration::CSlot::CSlot ( )

Definition at line 75 of file vdbcache.cpp.

◆ ~CSlot()

CVDBCacheWithExpiration::CSlot::~CSlot ( )
overridevirtual

Definition at line 80 of file vdbcache.cpp.

◆ CSlot() [2/2]

CVDBCacheWithExpiration::CSlot::CSlot ( const CSlot )
privatedelete

Member Function Documentation

◆ GetObject()

template<class Object >
CRef<Object> CVDBCacheWithExpiration::CSlot::GetObject ( void  ) const
inline

◆ GetSlotMutex()

TSlotMutex& CVDBCacheWithExpiration::CSlot::GetSlotMutex ( )
inline

Definition at line 99 of file vdbcache.hpp.

References m_SlotMutex.

Referenced by CWGSDataLoader_Impl::x_GetFileInfo().

◆ IsExpired()

bool CVDBCacheWithExpiration::CSlot::IsExpired ( const CVDBCacheWithExpiration cache,
const string acc_or_path 
) const

Definition at line 85 of file vdbcache.cpp.

Referenced by CWGSDataLoader_Impl::x_GetFileInfo().

◆ operator=()

void CVDBCacheWithExpiration::CSlot::operator= ( const CSlot )
privatedelete

◆ ResetObject()

void CVDBCacheWithExpiration::CSlot::ResetObject ( void  )
inline

Definition at line 113 of file vdbcache.hpp.

References SetObject().

Referenced by CWGSDataLoader_Impl::x_GetFileInfo().

◆ SetObject()

void CVDBCacheWithExpiration::CSlot::SetObject ( CObject object)
inline

Definition at line 109 of file vdbcache.hpp.

References m_Object.

Referenced by CWGSDataLoader_Impl::OpenWGSFileOnce(), and ResetObject().

◆ UpdateExpiration()

void CVDBCacheWithExpiration::CSlot::UpdateExpiration ( const CVDBCacheWithExpiration cache,
const string acc_or_path 
)

Friends And Related Function Documentation

◆ CVDBCacheWithExpiration

friend class CVDBCacheWithExpiration
friend

Definition at line 124 of file vdbcache.hpp.

Member Data Documentation

◆ m_ExpirationInfo

CRef<CExpirationInfo> CVDBCacheWithExpiration::CSlot::m_ExpirationInfo
private

Definition at line 130 of file vdbcache.hpp.

◆ m_Object

CRef<CObject> CVDBCacheWithExpiration::CSlot::m_Object
private

Definition at line 131 of file vdbcache.hpp.

Referenced by GetObject(), and SetObject().

◆ m_SlotMutex

TSlotMutex CVDBCacheWithExpiration::CSlot::m_SlotMutex
private

Definition at line 129 of file vdbcache.hpp.

Referenced by GetSlotMutex().


The documentation for this class was generated from the following files:
Modified on Sat Dec 09 04:50:00 2023 by modify_doxy.py rev. 669887