NCBI C++ ToolKit
Public Member Functions | List of all members
C_FA_Storage Class Referenceabstract

Search Toolkit Book for C_FA_Storage

#include "memory_store.hpp"
(Private to src/dbapi/driver.)

+ Inheritance diagram for C_FA_Storage:
+ Collaboration diagram for C_FA_Storage:

Public Member Functions

virtual size_t Insert (const void *buff, size_t nof_bytes)=0
 
virtual size_t Delete (size_t nof_bytes)=0
 
virtual size_t Truncate (size_t nof_bytes)=0
 
virtual ~C_FA_Storage ()
 
- Public Member Functions inherited from C_RA_Storage
virtual long Seek (long offset, EWhence whence)=0
 
virtual size_t Tell (void) const =0
 
virtual size_t Write (const void *buff, size_t nof_bytes)=0
 
virtual ~C_RA_Storage ()
 
- Public Member Functions inherited from C_SA_Storage
virtual size_t Read (void *buff, size_t nof_bytes)=0
 
virtual size_t Append (const void *buff, size_t nof_bytes)=0
 
virtual void Flush (void)=0
 
virtual ~C_SA_Storage ()
 
- 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 C_RA_Storage
enum  EWhence { eCurr , eHead , eTail }
 
- 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 77 of file memory_store.hpp.

Constructor & Destructor Documentation

◆ ~C_FA_Storage()

virtual C_FA_Storage::~C_FA_Storage ( )
inlinevirtual

Definition at line 84 of file memory_store.hpp.

Member Function Documentation

◆ Delete()

virtual size_t C_FA_Storage::Delete ( size_t  nof_bytes)
pure virtual

Implemented in CMemStore.

◆ Insert()

virtual size_t C_FA_Storage::Insert ( const void *  buff,
size_t  nof_bytes 
)
pure virtual

Implemented in CMemStore.

◆ Truncate()

virtual size_t C_FA_Storage::Truncate ( size_t  nof_bytes)
pure virtual

Implemented in CMemStore.


The documentation for this class was generated from the following file:
Modified on Sun Mar 03 03:16:18 2024 by modify_doxy.py rev. 669887