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

Search Toolkit Book for CInfoRequestorLock

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

+ Inheritance diagram for CInfoRequestorLock:
+ Collaboration diagram for CInfoRequestorLock:

Public Member Functions

 CInfoRequestorLock (CInfoRequestor &requestor, CInfo_Base &info)
 
 ~CInfoRequestorLock (void)
 
- 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 CInfo_Base::TExpirationTime TExpirationTime
 
typedef CMutex TMainMutex
 

Protected Member Functions

CInfo_BaseGetInfo (void) const
 
CInfoRequestorGetRequestor (void) const
 
TExpirationTime GetNewExpirationTime (EExpirationType type) const
 
CInfoManagerGetManager (void) const
 
bool IsLocked (void) const
 
bool IsLoaded (void) const
 
bool SetLoadedFor (TExpirationTime new_expiration_time)
 
bool SetLoaded (EExpirationType type)
 
TExpirationTime GetExpirationTime (void) const
 
bool x_SetLoadedFor (TMainMutex::TWriteLockGuard &guard, TExpirationTime new_expiration_time)
 
bool x_SetLoaded (TMainMutex::TWriteLockGuard &guard, EExpirationType type)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

CInfoRequestorm_Requestor
 
CRef< CInfo_Basem_Info
 
CRef< CLoadMutexm_Mutex
 

Friends

class CInfoLock_Base
 
class CInfoCache_Base
 
class CInfoRequestor
 
class CInfoManager
 

Additional Inherited Members

- 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...
 
- 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 140 of file info_cache.hpp.

Member Typedef Documentation

◆ TExpirationTime

Definition at line 151 of file info_cache.hpp.

◆ TMainMutex

Definition at line 178 of file info_cache.hpp.

Constructor & Destructor Documentation

◆ CInfoRequestorLock()

CInfoRequestorLock::CInfoRequestorLock ( CInfoRequestor requestor,
CInfo_Base info 
)

Definition at line 66 of file info_cache.cpp.

◆ ~CInfoRequestorLock()

CInfoRequestorLock::~CInfoRequestorLock ( void  )

Definition at line 74 of file info_cache.cpp.

Member Function Documentation

◆ GetExpirationTime()

TExpirationTime CInfoRequestorLock::GetExpirationTime ( void  ) const
inlineprotected

Definition at line 173 of file info_cache.hpp.

References CInfo_Base::GetExpirationTime(), and GetInfo().

Referenced by CInfoLock_Base::GetExpirationTime().

◆ GetInfo()

CInfo_Base& CInfoRequestorLock::GetInfo ( void  ) const
inlineprotected

◆ GetManager()

CInfoManager & CInfoRequestorLock::GetManager ( void  ) const
inlineprotected

◆ GetNewExpirationTime()

CInfoRequestorLock::TExpirationTime CInfoRequestorLock::GetNewExpirationTime ( EExpirationType  type) const
inlineprotected

◆ GetRequestor()

CInfoRequestor& CInfoRequestorLock::GetRequestor ( void  ) const
inlineprotected

◆ IsLoaded()

bool CInfoRequestorLock::IsLoaded ( void  ) const
inlineprotected

◆ IsLocked()

bool CInfoRequestorLock::IsLocked ( void  ) const
inlineprotected

◆ SetLoaded()

bool CInfoRequestorLock::SetLoaded ( EExpirationType  type)
inlineprotected

◆ SetLoadedFor()

bool CInfoRequestorLock::SetLoadedFor ( TExpirationTime  new_expiration_time)
protected

◆ x_SetLoaded()

bool CInfoRequestorLock::x_SetLoaded ( TMainMutex::TWriteLockGuard guard,
EExpirationType  type 
)
inlineprotected

Definition at line 328 of file info_cache.hpp.

References GetNewExpirationTime(), and x_SetLoadedFor().

◆ x_SetLoadedFor()

bool CInfoRequestorLock::x_SetLoadedFor ( TMainMutex::TWriteLockGuard guard,
TExpirationTime  new_expiration_time 
)
protected

Friends And Related Function Documentation

◆ CInfoCache_Base

friend class CInfoCache_Base
friend

Definition at line 148 of file info_cache.hpp.

◆ CInfoLock_Base

friend class CInfoLock_Base
friend

Definition at line 147 of file info_cache.hpp.

◆ CInfoManager

friend class CInfoManager
friend

Definition at line 150 of file info_cache.hpp.

◆ CInfoRequestor

friend class CInfoRequestor
friend

Definition at line 149 of file info_cache.hpp.

Member Data Documentation

◆ m_Info

CRef<CInfo_Base> CInfoRequestorLock::m_Info
protected

Definition at line 185 of file info_cache.hpp.

Referenced by GetInfo(), and CInfoManager::x_AcquireLoadLock().

◆ m_Mutex

CRef<CLoadMutex> CInfoRequestorLock::m_Mutex
protected

◆ m_Requestor

CInfoRequestor& CInfoRequestorLock::m_Requestor
protected

Definition at line 184 of file info_cache.hpp.

Referenced by GetRequestor().


The documentation for this class was generated from the following files:
Modified on Wed Apr 17 13:09:39 2024 by modify_doxy.py rev. 669887