NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
SNetStorageObjectImpl Struct Reference

Search Toolkit Book for SNetStorageObjectImpl

#include <connect/services/impl/netstorage_impl.hpp>

+ Inheritance diagram for SNetStorageObjectImpl:
+ Collaboration diagram for SNetStorageObjectImpl:

Public Member Functions

 ~SNetStorageObjectImpl ()
 
void SetStartState (INetStorageObjectState *state)
 
void SetIoMode (SNetStorageObjectIoMode::EApi api, SNetStorageObjectIoMode::EMth mth)
 
IEmbeddedStreamReaderWriterGetReaderWriter ()
 
CNcbiIostreamGetRWStream ()
 
INetStorageObjectStateoperator-> ()
 
const INetStorageObjectStateoperator-> () const
 
void Close ()
 
- 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
 

Static Public Member Functions

template<class TState , class... TArgs>
static SNetStorageObjectImplCreate (TArgs &&... args)
 
template<class TState , class TStarter , class... TArgs>
static SNetStorageObjectImplCreateAndStart (TStarter starter, TArgs &&... args)
 
- 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)
 

Private Member Functions

void EnterState (INetStorageObjectState *state)
 
void ExitState ()
 

Private Attributes

unique_ptr< IEmbeddedStreamReaderWriterm_ReaderWriter
 
unique_ptr< IEmbeddedStreamReaderWriterm_IoStreamReaderWriter
 
unique_ptr< INetStorageObjectStatem_Start
 
INetStorageObjectStatem_Previous = nullptr
 
INetStorageObjectStatem_Current = nullptr
 
SNetStorageObjectIoMode m_IoMode
 

Friends

struct INetStorageObjectState
 

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 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 159 of file netstorage_impl.hpp.

Constructor & Destructor Documentation

◆ ~SNetStorageObjectImpl()

SNetStorageObjectImpl::~SNetStorageObjectImpl ( )

Definition at line 203 of file netstorage.cpp.

References IEmbeddedStreamWriter::Close(), m_Current, and NCBI_CATCH_ALL.

Member Function Documentation

◆ Close()

void SNetStorageObjectImpl::Close ( void  )

◆ Create()

template<class TState , class... TArgs>
static SNetStorageObjectImpl* SNetStorageObjectImpl::Create ( TArgs &&...  args)
inlinestatic

Definition at line 179 of file netstorage_impl.hpp.

◆ CreateAndStart()

template<class TState , class TStarter , class... TArgs>
static SNetStorageObjectImpl* SNetStorageObjectImpl::CreateAndStart ( TStarter  starter,
TArgs &&...  args 
)
inlinestatic

Definition at line 185 of file netstorage_impl.hpp.

◆ EnterState()

void SNetStorageObjectImpl::EnterState ( INetStorageObjectState state)
inlineprivate

Definition at line 216 of file netstorage_impl.hpp.

References _ASSERT, m_Current, and m_Previous.

Referenced by INetStorageObjectState::EnterState().

◆ ExitState()

void SNetStorageObjectImpl::ExitState ( )
inlineprivate

Definition at line 223 of file netstorage_impl.hpp.

References _ASSERT, m_Current, and m_Previous.

Referenced by INetStorageObjectState::ExitState().

◆ GetReaderWriter()

IEmbeddedStreamReaderWriter & SNetStorageObjectImpl::GetReaderWriter ( )

Definition at line 197 of file netstorage.cpp.

References m_ReaderWriter.

◆ GetRWStream()

CNcbiIostream * SNetStorageObjectImpl::GetRWStream ( )

Definition at line 211 of file netstorage.cpp.

References m_IoStreamReaderWriter.

◆ operator->() [1/2]

INetStorageObjectState* SNetStorageObjectImpl::operator-> ( void  )
inline

Definition at line 173 of file netstorage_impl.hpp.

References _ASSERT, and m_Current.

◆ operator->() [2/2]

const INetStorageObjectState* SNetStorageObjectImpl::operator-> ( void  ) const
inline

Definition at line 174 of file netstorage_impl.hpp.

References _ASSERT, and m_Current.

◆ SetIoMode()

void SNetStorageObjectImpl::SetIoMode ( SNetStorageObjectIoMode::EApi  api,
SNetStorageObjectIoMode::EMth  mth 
)
inline

◆ SetStartState()

void SNetStorageObjectImpl::SetStartState ( INetStorageObjectState state)
inline

Definition at line 208 of file netstorage_impl.hpp.

References _ASSERT, m_Current, and m_Start.

Friends And Related Function Documentation

◆ INetStorageObjectState

friend struct INetStorageObjectState
friend

Definition at line 205 of file netstorage_impl.hpp.

Member Data Documentation

◆ m_Current

INetStorageObjectState* SNetStorageObjectImpl::m_Current = nullptr
private

◆ m_IoMode

SNetStorageObjectIoMode SNetStorageObjectImpl::m_IoMode
private

Definition at line 203 of file netstorage_impl.hpp.

Referenced by Close(), and SetIoMode().

◆ m_IoStreamReaderWriter

unique_ptr<IEmbeddedStreamReaderWriter> SNetStorageObjectImpl::m_IoStreamReaderWriter
private

Definition at line 199 of file netstorage_impl.hpp.

Referenced by GetRWStream().

◆ m_Previous

INetStorageObjectState* SNetStorageObjectImpl::m_Previous = nullptr
private

Definition at line 201 of file netstorage_impl.hpp.

Referenced by EnterState(), and ExitState().

◆ m_ReaderWriter

unique_ptr<IEmbeddedStreamReaderWriter> SNetStorageObjectImpl::m_ReaderWriter
private

Definition at line 198 of file netstorage_impl.hpp.

Referenced by GetReaderWriter().

◆ m_Start

unique_ptr<INetStorageObjectState> SNetStorageObjectImpl::m_Start
private

Definition at line 200 of file netstorage_impl.hpp.

Referenced by SetStartState().


The documentation for this struct was generated from the following files:
Modified on Wed Apr 17 13:10:34 2024 by modify_doxy.py rev. 669887