NCBI C++ ToolKit
Public Member Functions | List of all members
CDB_UserHandler_Exception Class Reference

Search Toolkit Book for CDB_UserHandler_Exception

#include <dbapi/driver/exception.hpp>

+ Inheritance diagram for CDB_UserHandler_Exception:
+ Collaboration diagram for CDB_UserHandler_Exception:

Public Member Functions

virtual ~CDB_UserHandler_Exception (void)
 
virtual bool HandleIt (CDB_Exception *ex)
 Handle the exceptions resulting from a native API call, one-by-one. More...
 
virtual bool HandleAll (const TExceptions &exceptions)
 Handle all of the exceptions resulting from a native API call. More...
 
- Public Member Functions inherited from CDB_UserHandler
 CDB_UserHandler (void)
 
virtual ~CDB_UserHandler (void)
 
virtual bool HandleMessage (int severity, int msgnum, const string &message)
 Handle message resulting from a native API call. More...
 
string GetExtraMsg (void) const
 Method is deprecated. Use CDB_Exception::GetExtraMsg() instead. More...
 
void SetExtraMsg (const string &msg) const
 Method is deprecated. Use CDB_Exception::SetExtraMsg() instead. 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
 

Additional Inherited Members

- Public Types inherited from CDB_UserHandler
typedef deque< CDB_Exception * > TExceptions
 Exception container type. More...
 
- 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 CDB_UserHandler
static void ClearExceptions (TExceptions &expts)
 
static CDB_UserHandlerGetDefault (void)
 
static CDB_UserHandlerSetDefault (CDB_UserHandler *h)
 
- 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...
 
- Protected Member Functions inherited from CDB_UserHandler
bool x_HandleAll (const TExceptions &exceptions)
 Simply call HandleIt on each exception. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 648 of file exception.hpp.

Constructor & Destructor Documentation

CDB_UserHandler_Exception::~CDB_UserHandler_Exception ( void  )
virtual

Definition at line 787 of file exception.cpp.

Member Function Documentation

bool CDB_UserHandler_Exception::HandleAll ( const TExceptions exceptions)
virtual

Handle all of the exceptions resulting from a native API call.

Parameters
exceptionsList of exceptions
Returns
TRUE if the exceptions are handled – in this case, HandleIt() methods will *NOT* be called.
See also
HandleIt(), CException::Throw()

Reimplemented from CDB_UserHandler.

Definition at line 815 of file exception.cpp.

References eDiag_Info, ERR_POST_X, CDB_Exception::GetDBErrCode(), and NULL.

bool CDB_UserHandler_Exception::HandleIt ( CDB_Exception ex)
virtual

Handle the exceptions resulting from a native API call, one-by-one.

Returns
TRUE if "ex" is processed, FALSE if not (or if "ex" is NULL)
See also
HandleAll(), CException::Throw()

Implements CDB_UserHandler.

Definition at line 792 of file exception.cpp.

References eDiag_Info, ERR_POST_X, and CDB_Exception::GetDBErrCode().


The documentation for this class was generated from the following files:
Modified on Sat Dec 16 14:08:38 2017 by modify_doxy.py rev. 546573