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

Search Toolkit Book for CInfoManager

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

+ Inheritance diagram for CInfoManager:
+ Collaboration diagram for CInfoManager:

Public Types

typedef CMutex TMainMutex
 
- 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

 CInfoManager (void)
 
virtual ~CInfoManager (void)
 
TMainMutexGetMainMutex (void)
 
void ReleaseAllLoadLocks (CInfoRequestor &requestor)
 
void ReleaseLoadLock (CInfoRequestorLock &lock)
 
- 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 Types

typedef vector< CRef< CLoadMutex > > TLoadMutexPool
 

Protected Member Functions

bool x_WaitForOtherLoader (TMainMutex::TWriteLockGuard &guard, CInfoRequestorLock &lock)
 
bool x_DeadLock (const CInfoRequestor &requestor, const CInfo_Base &info) const
 
void x_AssignLoadMutex (CRef< CLoadMutex > &mutex)
 
void x_ReleaseLoadMutex (CRef< CLoadMutex > &mutex)
 
void x_AssignLoadMutex (CInfo_Base &info)
 
void x_ReleaseLoadMutex (CInfo_Base &info)
 
void x_LockInfoMutex (CInfoRequestorLock &lock)
 
void x_UnlockInfoMutex (CInfoRequestorLock &lock)
 
void x_ReleaseLoadLock (CInfoRequestorLock &lock)
 
void x_AcquireLoadLock (TMainMutex::TWriteLockGuard &guard, CInfoRequestorLock &lock, EDoNotWait do_not_wait)
 
void x_AcquireLoadLock (CInfoRequestorLock &lock, EDoNotWait do_not_wait)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

TMainMutex m_MainMutex
 
CFastMutex m_DeadlockMutex
 
TLoadMutexPool m_LoadMutexPool
 

Friends

class CInfoRequestor
 
class CInfoRequestorLock
 
class CInfoCache_Base
 

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

Detailed Description

Definition at line 190 of file info_cache.hpp.

Member Typedef Documentation

◆ TLoadMutexPool

typedef vector< CRef<CLoadMutex> > CInfoManager::TLoadMutexPool
protected

Definition at line 231 of file info_cache.hpp.

◆ TMainMutex

Definition at line 196 of file info_cache.hpp.

Constructor & Destructor Documentation

◆ CInfoManager()

CInfoManager::CInfoManager ( void  )

Definition at line 121 of file info_cache.cpp.

◆ ~CInfoManager()

CInfoManager::~CInfoManager ( void  )
virtual

Definition at line 126 of file info_cache.cpp.

Member Function Documentation

◆ GetMainMutex()

TMainMutex& CInfoManager::GetMainMutex ( void  )
inline

◆ ReleaseAllLoadLocks()

void CInfoManager::ReleaseAllLoadLocks ( CInfoRequestor requestor)

◆ ReleaseLoadLock()

void CInfoManager::ReleaseLoadLock ( CInfoRequestorLock lock)

◆ x_AcquireLoadLock() [1/2]

void CInfoManager::x_AcquireLoadLock ( CInfoRequestorLock lock,
EDoNotWait  do_not_wait 
)
protected

◆ x_AcquireLoadLock() [2/2]

void CInfoManager::x_AcquireLoadLock ( TMainMutex::TWriteLockGuard guard,
CInfoRequestorLock lock,
EDoNotWait  do_not_wait 
)
protected

◆ x_AssignLoadMutex() [1/2]

void CInfoManager::x_AssignLoadMutex ( CInfo_Base info)
protected

Definition at line 188 of file info_cache.cpp.

References info, and x_AssignLoadMutex().

◆ x_AssignLoadMutex() [2/2]

void CInfoManager::x_AssignLoadMutex ( CRef< CLoadMutex > &  mutex)
protected

◆ x_DeadLock()

bool CInfoManager::x_DeadLock ( const CInfoRequestor requestor,
const CInfo_Base info 
) const
protected

◆ x_LockInfoMutex()

void CInfoManager::x_LockInfoMutex ( CInfoRequestorLock lock)
protected

◆ x_ReleaseLoadLock()

void CInfoManager::x_ReleaseLoadLock ( CInfoRequestorLock lock)
protected

◆ x_ReleaseLoadMutex() [1/2]

void CInfoManager::x_ReleaseLoadMutex ( CInfo_Base info)
protected

Definition at line 194 of file info_cache.cpp.

References info, and x_ReleaseLoadMutex().

◆ x_ReleaseLoadMutex() [2/2]

void CInfoManager::x_ReleaseLoadMutex ( CRef< CLoadMutex > &  mutex)
protected

◆ x_UnlockInfoMutex()

void CInfoManager::x_UnlockInfoMutex ( CInfoRequestorLock lock)
protected

◆ x_WaitForOtherLoader()

bool CInfoManager::x_WaitForOtherLoader ( TMainMutex::TWriteLockGuard guard,
CInfoRequestorLock lock 
)
protected

Friends And Related Function Documentation

◆ CInfoCache_Base

friend class CInfoCache_Base
friend

Definition at line 208 of file info_cache.hpp.

◆ CInfoRequestor

friend class CInfoRequestor
friend

Definition at line 206 of file info_cache.hpp.

◆ CInfoRequestorLock

friend class CInfoRequestorLock
friend

Definition at line 207 of file info_cache.hpp.

Member Data Documentation

◆ m_DeadlockMutex

CFastMutex CInfoManager::m_DeadlockMutex
mutableprotected

Definition at line 234 of file info_cache.hpp.

Referenced by x_DeadLock(), and x_WaitForOtherLoader().

◆ m_LoadMutexPool

TLoadMutexPool CInfoManager::m_LoadMutexPool
protected

Definition at line 235 of file info_cache.hpp.

Referenced by x_AssignLoadMutex(), and x_ReleaseLoadMutex().

◆ m_MainMutex

TMainMutex CInfoManager::m_MainMutex
protected

Definition at line 233 of file info_cache.hpp.

Referenced by GetMainMutex().


The documentation for this class was generated from the following files:
Modified on Sun Jun 23 05:15:02 2024 by modify_doxy.py rev. 669887