NCBI C++ ToolKit
Public Member Functions | Public Attributes | List of all members
SNetServerConnectionImpl Struct Reference

Search Toolkit Book for SNetServerConnectionImpl

#include "srv_connections_impl.hpp"
(Private to src/connect/services.)

+ Inheritance diagram for SNetServerConnectionImpl:
+ Collaboration diagram for SNetServerConnectionImpl:

Public Member Functions

 SNetServerConnectionImpl (SNetServerImpl *pool)
virtual void DeleteThis ()
 Virtual method "deleting" this object. More...
void WriteLine (const string &line)
void ReadCmdOutputLine (string &result, bool multiline_output)
void Close ()
void Abort ()
virtual ~SNetServerConnectionImpl ()
- 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

Public Attributes

CNetServer m_Server
CAtomicCounter::TValue m_Generation
CSocket m_Socket

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...

Detailed Description

Definition at line 108 of file srv_connections_impl.hpp.

Constructor & Destructor Documentation

◆ SNetServerConnectionImpl()

SNetServerConnectionImpl::SNetServerConnectionImpl ( SNetServerImpl pool)

Definition at line 145 of file srv_connections.cpp.

References eIO_Close, m_Socket, s_ZeroTimeout, and CSocket::SetTimeout().

◆ ~SNetServerConnectionImpl()

SNetServerConnectionImpl::~SNetServerConnectionImpl ( )

Definition at line 255 of file srv_connections.cpp.

References Close().

Member Function Documentation

◆ Abort()

void SNetServerConnectionImpl::Abort ( void  )

◆ Close()

void SNetServerConnectionImpl::Close ( void  )

◆ DeleteThis()

void SNetServerConnectionImpl::DeleteThis ( void  )

Virtual method "deleting" this object.

Method is called whenever by all other indicators this object should be deleted. These indicators are: last reference to the object is removed, object created on heap and method DoNotDeleteThisObject() was not called. Default implementation actually deletes the object, but derived classes are free to do whatever they want (e.g. if they know that they are allocated at some pool they should return themselves to this pool).

Reimplemented from CObject.

Definition at line 155 of file srv_connections.cpp.

References eIO_Open, eIO_Success, CAtomicCounter::Get(), CSocket::GetStatus(), SNetServerInPool::m_CurrentConnectionGeneration, SNetServerInPool::m_FreeConnectionListHead, SNetServerInPool::m_FreeConnectionListLock, SNetServerInPool::m_FreeConnectionListSize, m_Generation, m_NextFree, m_Server, SNetServerImpl::m_ServerInPool, m_Socket, and NULL.

◆ ReadCmdOutputLine()

void SNetServerConnectionImpl::ReadCmdOutputLine ( string result,
bool  multiline_output 

◆ WriteLine()

void SNetServerConnectionImpl::WriteLine ( const string line)

Member Data Documentation

◆ m_Generation

CAtomicCounter::TValue SNetServerConnectionImpl::m_Generation

Definition at line 126 of file srv_connections_impl.hpp.

Referenced by DeleteThis().

◆ m_NextFree

SNetServerConnectionImpl* SNetServerConnectionImpl::m_NextFree

Definition at line 127 of file srv_connections_impl.hpp.

Referenced by DeleteThis().

◆ m_Server

CNetServer SNetServerConnectionImpl::m_Server

◆ m_Socket

CSocket SNetServerConnectionImpl::m_Socket

The documentation for this struct was generated from the following files:
Modified on Thu May 23 12:32:40 2024 by rev. 669887