NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
CInfo_Base Class Reference

Search Toolkit Book for CInfo_Base

#include <objtools/data_loaders/genbank/impl/info_cache.hpp>

+ Inheritance diagram for CInfo_Base:
+ Collaboration diagram for CInfo_Base:

Public Types

typedef Uint4 TExpirationTime
 
typedef int TUseCounter
 
typedef list< CRef< CInfo_Base > > TGCQueue
 
- 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

 CInfo_Base (TGCQueue &gc_queue)
 
virtual ~CInfo_Base (void)
 
bool IsLoaded (TExpirationTime expiration_time) const
 
bool IsLoaded (CInfoRequestor &requestor) const
 
TExpirationTime GetExpirationTime (void) const
 
- 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
 

Protected Attributes

TUseCounter m_UseCounter
 
atomic< TExpirationTimem_ExpirationTime
 
CRef< CLoadMutexm_LoadMutex
 
TGCQueue::iterator m_GCQueuePos
 

Friends

class CInfoRequestorLock
 
class CInfoCache_Base
 
class CInfoManager
 
class CInfoRequestor
 

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...
 
- Private Member Functions inherited from INoCopying
 INoCopying ()
 

Detailed Description

Definition at line 105 of file info_cache.hpp.

Member Typedef Documentation

◆ TExpirationTime

Definition at line 108 of file info_cache.hpp.

◆ TGCQueue

Definition at line 110 of file info_cache.hpp.

◆ TUseCounter

Definition at line 109 of file info_cache.hpp.

Constructor & Destructor Documentation

◆ CInfo_Base()

CInfo_Base::CInfo_Base ( TGCQueue gc_queue)
explicit

Definition at line 48 of file info_cache.cpp.

◆ ~CInfo_Base()

CInfo_Base::~CInfo_Base ( void  )
virtual

Definition at line 56 of file info_cache.cpp.

Member Function Documentation

◆ GetExpirationTime()

TExpirationTime CInfo_Base::GetExpirationTime ( void  ) const
inline

Definition at line 117 of file info_cache.hpp.

References m_ExpirationTime.

Referenced by CInfoRequestorLock::GetExpirationTime(), and IsLoaded().

◆ IsLoaded() [1/2]

bool CInfo_Base::IsLoaded ( CInfoRequestor requestor) const
inline

Definition at line 299 of file info_cache.hpp.

References CInfoRequestor::GetRequestTime(), and IsLoaded().

◆ IsLoaded() [2/2]

bool CInfo_Base::IsLoaded ( TExpirationTime  expiration_time) const
inline

Definition at line 292 of file info_cache.hpp.

References GetExpirationTime().

Referenced by IsLoaded(), and CInfoRequestorLock::IsLoaded().

Friends And Related Function Documentation

◆ CInfoCache_Base

friend class CInfoCache_Base
friend

Definition at line 124 of file info_cache.hpp.

◆ CInfoManager

friend class CInfoManager
friend

Definition at line 125 of file info_cache.hpp.

◆ CInfoRequestor

friend class CInfoRequestor
friend

Definition at line 126 of file info_cache.hpp.

◆ CInfoRequestorLock

friend class CInfoRequestorLock
friend

Definition at line 123 of file info_cache.hpp.

Member Data Documentation

◆ m_ExpirationTime

atomic<TExpirationTime> CInfo_Base::m_ExpirationTime
protected

Definition at line 131 of file info_cache.hpp.

Referenced by GetExpirationTime().

◆ m_GCQueuePos

TGCQueue::iterator CInfo_Base::m_GCQueuePos
protected

Definition at line 133 of file info_cache.hpp.

◆ m_LoadMutex

CRef<CLoadMutex> CInfo_Base::m_LoadMutex
protected

Definition at line 132 of file info_cache.hpp.

Referenced by CInfoManager::x_DeadLock(), and CInfoManager::x_UnlockInfoMutex().

◆ m_UseCounter

TUseCounter CInfo_Base::m_UseCounter
protected

Definition at line 129 of file info_cache.hpp.


The documentation for this class was generated from the following files:
Modified on Thu Nov 30 04:55:23 2023 by modify_doxy.py rev. 669887