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

Search Toolkit Book for CTSE_Lock

#include <objmgr/impl/tse_lock.hpp>

+ Collaboration diagram for CTSE_Lock:

Public Member Functions

 CTSE_Lock (void)
 
 CTSE_Lock (const CTSE_Lock &lock)
 
 CTSE_Lock (const CTSE_LoadLock &load_lock)
 
 ~CTSE_Lock (void)
 
CTSE_Lock & operator= (const CTSE_Lock &lock)
 
 operator const CTSE_Info * (void) const
 
bool operator== (const CTSE_Lock &lock) const
 
bool operator!= (const CTSE_Lock &lock) const
 
bool operator< (const CTSE_Lock &lock) const
 
const CTSE_Info * GetPointerOrNull (void) const
 
const CTSE_Info * GetNonNullPointer (void) const
 
const CTSE_Info & operator* (void) const
 
const CTSE_Info * operator-> (void) const
 
void Reset (void)
 
void Drop (void)
 
void Swap (CTSE_Lock &lock)
 

Protected Member Functions

bool Lock (const CTSE_Info *info)
 
void x_Assign (const CTSE_Lock &lock)
 
void x_Assign (const CTSE_LoadLock &load_lock)
 
void x_Unlock (void)
 
void x_Drop (void)
 
bool x_Lock (const CTSE_Info *info)
 
void x_Relock (const CTSE_Info *info)
 

Private Attributes

CConstRef< CObject > m_Info
 

Friends

class CDataSource
 

Detailed Description

Definition at line 44 of file tse_lock.hpp.

Constructor & Destructor Documentation

◆ CTSE_Lock() [1/3]

CTSE_Lock::CTSE_Lock ( void  )
inline

Definition at line 47 of file tse_lock.hpp.

◆ CTSE_Lock() [2/3]

CTSE_Lock::CTSE_Lock ( const CTSE_Lock &  lock)
inline

Definition at line 50 of file tse_lock.hpp.

References x_Assign().

◆ CTSE_Lock() [3/3]

CTSE_Lock::CTSE_Lock ( const CTSE_LoadLock &  load_lock)
inline

Definition at line 54 of file tse_lock.hpp.

References x_Assign().

◆ ~CTSE_Lock()

CTSE_Lock::~CTSE_Lock ( void  )
inline

Definition at line 58 of file tse_lock.hpp.

References Reset().

Member Function Documentation

◆ Drop()

void CTSE_Lock::Drop ( void  )
inline

Definition at line 114 of file tse_lock.hpp.

References m_Info, and x_Drop().

◆ GetNonNullPointer()

const CTSE_Info* CTSE_Lock::GetNonNullPointer ( void  ) const
inline

Definition at line 94 of file tse_lock.hpp.

References CConstRef< C, Locker >::GetNonNullPointer(), and m_Info.

Referenced by CDataSource::GetTSE_LoadLockIfLoaded(), operator*(), operator->(), x_Drop(), CDataSource::x_ReleaseLastLock(), CDataSource::x_SetLoadLock(), and x_Unlock().

◆ GetPointerOrNull()

const CTSE_Info* CTSE_Lock::GetPointerOrNull ( void  ) const
inline

Definition at line 89 of file tse_lock.hpp.

References CConstRef< C, Locker >::GetPointerOrNull(), and m_Info.

Referenced by Lock(), operator const CTSE_Info *(), CPSGL_Blob_Processor::ProcessTSE_Lock(), and x_Assign().

◆ Lock()

bool CTSE_Lock::Lock ( const CTSE_Info *  info)
inlineprotected

Definition at line 128 of file tse_lock.hpp.

References GetPointerOrNull(), info, Reset(), and x_Lock().

◆ operator const CTSE_Info *()

CTSE_Lock::operator const CTSE_Info * ( void  ) const
inline

Definition at line 71 of file tse_lock.hpp.

References GetPointerOrNull().

◆ operator!=()

bool CTSE_Lock::operator!= ( const CTSE_Lock &  lock) const
inline

Definition at line 80 of file tse_lock.hpp.

References m_Info.

◆ operator*()

const CTSE_Info& CTSE_Lock::operator* ( void  ) const
inline

Definition at line 99 of file tse_lock.hpp.

References GetNonNullPointer().

◆ operator->()

const CTSE_Info* CTSE_Lock::operator-> ( void  ) const
inline

Definition at line 103 of file tse_lock.hpp.

References GetNonNullPointer().

◆ operator<()

bool CTSE_Lock::operator< ( const CTSE_Lock &  lock) const
inline

Definition at line 84 of file tse_lock.hpp.

References m_Info.

◆ operator=()

CTSE_Lock& CTSE_Lock::operator= ( const CTSE_Lock &  lock)
inline

Definition at line 62 of file tse_lock.hpp.

References m_Info, Reset(), and x_Assign().

◆ operator==()

bool CTSE_Lock::operator== ( const CTSE_Lock &  lock) const
inline

Definition at line 76 of file tse_lock.hpp.

References m_Info.

◆ Reset()

void CTSE_Lock::Reset ( void  )
inline

Definition at line 108 of file tse_lock.hpp.

References m_Info, and x_Unlock().

Referenced by CTSE_ScopeInfo::DropTSE_Lock(), Lock(), operator=(), CScope_Impl::RemoveTopLevelSeqEntry(), CTSE_ScopeInfo::x_DetachDS(), and ~CTSE_Lock().

◆ Swap()

void CTSE_Lock::Swap ( CTSE_Lock &  lock)

Definition at line 2543 of file data_source.cpp.

References m_Info, CConstRef< C, Locker >::Swap(), and tmp.

Referenced by CTSE_ScopeInfo::x_ResetTSE_Lock().

◆ x_Assign() [1/2]

void CTSE_Lock::x_Assign ( const CTSE_LoadLock &  load_lock)
protected

Definition at line 2456 of file data_source.cpp.

References _ASSERT, CTSE_LoadLock::IsLoaded(), and x_Relock().

◆ x_Assign() [2/2]

void CTSE_Lock::x_Assign ( const CTSE_Lock &  lock)
inlineprotected

Definition at line 139 of file tse_lock.hpp.

References GetPointerOrNull(), info, and x_Relock().

Referenced by CTSE_Lock(), and operator=().

◆ x_Drop()

void CTSE_Lock::x_Drop ( void  )
protected

Definition at line 2533 of file data_source.cpp.

References _ASSERT, _VERIFY, GetNonNullPointer(), info, m_Info, CConstRef< C, Locker >::Reset(), and TSE_LOCK_TRACE.

Referenced by Drop().

◆ x_Lock()

bool CTSE_Lock::x_Lock ( const CTSE_Info *  info)
protected

Definition at line 2572 of file data_source.cpp.

References _ASSERT, info, m_Info, CConstRef< C, Locker >::Reset(), and TSE_LOCK_TRACE.

Referenced by Lock().

◆ x_Relock()

void CTSE_Lock::x_Relock ( const CTSE_Info *  info)
protected

Definition at line 2581 of file data_source.cpp.

References _ASSERT, info, m_Info, CConstRef< C, Locker >::Reset(), and TSE_LOCK_TRACE.

Referenced by x_Assign().

◆ x_Unlock()

void CTSE_Lock::x_Unlock ( void  )
protected

Definition at line 2555 of file data_source.cpp.

References _ASSERT, GetNonNullPointer(), info, m_Info, CConstRef< C, Locker >::Reset(), TSE_LOCK_TRACE, and CDataSource::x_ReleaseLastLock().

Referenced by Reset().

Friends And Related Function Documentation

◆ CDataSource

friend class CDataSource
friend

Definition at line 125 of file tse_lock.hpp.

Member Data Documentation

◆ m_Info

CConstRef<CObject> CTSE_Lock::m_Info
private

Definition at line 155 of file tse_lock.hpp.

Referenced by Drop(), GetNonNullPointer(), GetPointerOrNull(), operator!=(), operator<(), operator=(), operator==(), Reset(), Swap(), x_Drop(), x_Lock(), CDataSource::x_ReleaseLastLock(), x_Relock(), CDataSource::x_SetLock(), and x_Unlock().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.0
Modified on Fri Sep 20 14:57:39 2024 by modify_doxy.py rev. 669887