NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
IDBConnectionFactory Class Referenceabstract

Search Toolkit Book for IDBConnectionFactory

IDBConnectionFactory. More...

#include <dbapi/driver/dbapi_driver_conn_mgr.hpp>

+ Inheritance diagram for IDBConnectionFactory:
+ Collaboration diagram for IDBConnectionFactory:

Public Member Functions

 IDBConnectionFactory (void)
 IDBConnectionFactory will take ownership of validator if there is any. More...
 
virtual ~IDBConnectionFactory (void)
 
virtual void Configure (const IRegistry *registry=NULL)=0
 Configure connection policy using registry. More...
 
- 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 Member Functions

virtual CDB_ConnectionMakeDBConnection (I_DriverContext &ctx, const CDBConnParams &params)=0
 Create new connection object for the given context and connection attributes. More...
 
virtual CDB_UserHandler::TExceptionsGetExceptions (void)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Static Protected Member Functions

static CDB_ConnectionCtxMakeConnection (I_DriverContext &ctx, const CDBConnParams &params)
 Helper method to provide access to a protected method in I_DriverContext for child classses. More...
 

Friends

class impl::CDriverContext
 
class CDBPoolBalancer
 

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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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...
 

Detailed Description

IDBConnectionFactory.

Definition at line 88 of file dbapi_driver_conn_mgr.hpp.

Constructor & Destructor Documentation

IDBConnectionFactory::IDBConnectionFactory ( void  )

IDBConnectionFactory will take ownership of validator if there is any.

Definition at line 119 of file dbapi_driver_conn_mgr.cpp.

IDBConnectionFactory::~IDBConnectionFactory ( void  )
virtual

Definition at line 123 of file dbapi_driver_conn_mgr.cpp.

Member Function Documentation

virtual void IDBConnectionFactory::Configure ( const IRegistry registry = NULL)
pure virtual

Configure connection policy using registry.

Implemented in CDBConnectionFactory, and CDefaultConnectPolicy.

CDB_Connection * IDBConnectionFactory::CtxMakeConnection ( I_DriverContext ctx,
const CDBConnParams params 
)
inlinestaticprotected

Helper method to provide access to a protected method in I_DriverContext for child classses.

Definition at line 179 of file dbapi_driver_conn_mgr.hpp.

References I_DriverContext::MakePooledConnection().

Referenced by CDBPoolBalancer::GetServer(), CDefaultConnectPolicy::MakeDBConnection(), and CDBConnectionFactory::MakeValidConnection().

virtual CDB_UserHandler::TExceptions* IDBConnectionFactory::GetExceptions ( void  )
inlineprotectedvirtual

Reimplemented in CDBConnectionFactory.

Definition at line 111 of file dbapi_driver_conn_mgr.hpp.

References NULL.

Referenced by impl::CDriverContext::MakeConnection().

virtual CDB_Connection* IDBConnectionFactory::MakeDBConnection ( I_DriverContext ctx,
const CDBConnParams params 
)
protectedpure virtual

Create new connection object for the given context and connection attributes.

Implemented in CDBConnectionFactory, and CDefaultConnectPolicy.

Referenced by impl::CDriverContext::MakeConnection().

Friends And Related Function Documentation

friend class CDBPoolBalancer
friend

Definition at line 119 of file dbapi_driver_conn_mgr.hpp.

friend class impl::CDriverContext
friend

Definition at line 118 of file dbapi_driver_conn_mgr.hpp.


The documentation for this class was generated from the following files:
Modified on Thu Feb 22 13:23:24 2018 by modify_doxy.py rev. 546573