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

Search Toolkit Book for CConnHolder

#include "sdbapi_impl.hpp"
(Private to src/dbapi/simple.)

+ Inheritance diagram for CConnHolder:
+ Collaboration diagram for CConnHolder:

Public Member Functions

 CConnHolder (IConnection *conn, const CSDB_ConnectionParam &params)
 
virtual ~CConnHolder (void)
 
IConnectionGetConn (void) const
 
void AddOpenRef (void)
 
void CloseRef (void)
 
const CDB_Exception::SContextGetContext (void) const
 
void SetTimeout (const CTimeout &timeout)
 
void ResetTimeout (void)
 
const list< string > & GetPrintOutput (void) const
 
void ResetPrintOutput ()
 
- 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

 CConnHolder (const CConnHolder &)
 
CConnHolderoperator= (const CConnHolder &)
 

Private Attributes

IConnectionm_Conn
 
size_t m_DefaultTimeout
 
bool m_HasCustomTimeout
 
bool m_ContinueAfterRaiserror
 
bool m_LogMinorMessages
 
Uint4 m_CntOpen
 
list< stringm_PrintOutput
 
CRef< CDB_Exception::SContextm_Context
 
CRef< CSDB_UserHandlerm_Handler
 
CMutex m_Mutex
 

Friends

class CSDB_UserHandler
 

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

Detailed Description

Definition at line 57 of file sdbapi_impl.hpp.

Constructor & Destructor Documentation

◆ CConnHolder() [1/2]

CConnHolder::CConnHolder ( IConnection conn,
const CSDB_ConnectionParam params 
)
inline

◆ ~CConnHolder()

CConnHolder::~CConnHolder ( void  )
virtual

Definition at line 1808 of file sdbapi.cpp.

References m_Conn.

◆ CConnHolder() [2/2]

CConnHolder::CConnHolder ( const CConnHolder )
private

Member Function Documentation

◆ AddOpenRef()

void CConnHolder::AddOpenRef ( void  )
inline

Definition at line 1820 of file sdbapi.cpp.

References m_CntOpen, and m_Mutex.

Referenced by CDatabaseImpl::CDatabaseImpl(), and CDatabaseImpl::Connect().

◆ CloseRef()

void CConnHolder::CloseRef ( void  )
inline

◆ GetConn()

IConnection * CConnHolder::GetConn ( void  ) const
inline

Definition at line 1814 of file sdbapi.cpp.

References m_Conn.

Referenced by CDatabaseImpl::GetConnection().

◆ GetContext()

const CDB_Exception::SContext & CConnHolder::GetContext ( void  ) const
inline

Definition at line 1875 of file sdbapi.cpp.

References m_Context.

Referenced by CDatabaseImpl::GetContext().

◆ GetPrintOutput()

const list< string > & CConnHolder::GetPrintOutput ( void  ) const
inline

Definition at line 1862 of file sdbapi.cpp.

References m_PrintOutput.

Referenced by CDatabaseImpl::GetPrintOutput().

◆ operator=()

CConnHolder& CConnHolder::operator= ( const CConnHolder )
private

◆ ResetPrintOutput()

void CConnHolder::ResetPrintOutput ( void  )
inline

Definition at line 1868 of file sdbapi.cpp.

References m_Mutex, and m_PrintOutput.

Referenced by CDatabaseImpl::ResetPrintOutput().

◆ ResetTimeout()

void CConnHolder::ResetTimeout ( void  )

◆ SetTimeout()

void CConnHolder::SetTimeout ( const CTimeout timeout)

Friends And Related Function Documentation

◆ CSDB_UserHandler

friend class CSDB_UserHandler
friend

Definition at line 88 of file sdbapi_impl.hpp.

Member Data Documentation

◆ m_CntOpen

Uint4 CConnHolder::m_CntOpen
private

Definition at line 82 of file sdbapi_impl.hpp.

Referenced by AddOpenRef(), CloseRef(), ResetTimeout(), and SetTimeout().

◆ m_Conn

IConnection* CConnHolder::m_Conn
private

Definition at line 77 of file sdbapi_impl.hpp.

Referenced by CloseRef(), GetConn(), ResetTimeout(), SetTimeout(), and ~CConnHolder().

◆ m_Context

CRef<CDB_Exception::SContext> CConnHolder::m_Context
private

Definition at line 84 of file sdbapi_impl.hpp.

Referenced by CConnHolder(), GetContext(), and CSDB_UserHandler::HandleMessage().

◆ m_ContinueAfterRaiserror

bool CConnHolder::m_ContinueAfterRaiserror
private

Definition at line 80 of file sdbapi_impl.hpp.

Referenced by CSDB_UserHandler::HandleMessage().

◆ m_DefaultTimeout

size_t CConnHolder::m_DefaultTimeout
private

Definition at line 78 of file sdbapi_impl.hpp.

Referenced by CConnHolder(), and ResetTimeout().

◆ m_Handler

CRef<CSDB_UserHandler> CConnHolder::m_Handler
private

Definition at line 85 of file sdbapi_impl.hpp.

Referenced by CConnHolder(), and CloseRef().

◆ m_HasCustomTimeout

bool CConnHolder::m_HasCustomTimeout
private

Definition at line 79 of file sdbapi_impl.hpp.

Referenced by ResetTimeout(), and SetTimeout().

◆ m_LogMinorMessages

bool CConnHolder::m_LogMinorMessages
private

Definition at line 81 of file sdbapi_impl.hpp.

Referenced by CSDB_UserHandler::HandleIt(), and CSDB_UserHandler::HandleMessage().

◆ m_Mutex

CMutex CConnHolder::m_Mutex
private

Definition at line 86 of file sdbapi_impl.hpp.

Referenced by AddOpenRef(), CloseRef(), ResetPrintOutput(), ResetTimeout(), and SetTimeout().

◆ m_PrintOutput

list<string> CConnHolder::m_PrintOutput
private

The documentation for this class was generated from the following files:
Modified on Wed Nov 29 02:19:51 2023 by modify_doxy.py rev. 669887