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

Search Toolkit Book for SServerScanInfo

+ Inheritance diagram for SServerScanInfo:
+ Collaboration diagram for SServerScanInfo:

Public Types

typedef vector< AutoPtr< SSERV_Info, CDeleter< SSERV_Info > > > TSkipServers
 
- 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...
 

Public Member Functions

 SServerScanInfo (const TSkipServers &skip_servers)
 
void Reset (void)
 
bool SkipServer (const SSERV_Info *server)
 
- 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

int m_TotalCount
 
int m_SkippedCount
 
const SSERV_Infom_CurrentServer
 
const TSkipServersm_SkipServers
 

Additional Inherited Members

- 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 97 of file reader_service.cpp.

Member Typedef Documentation

◆ TSkipServers

Definition at line 99 of file reader_service.cpp.

Constructor & Destructor Documentation

◆ SServerScanInfo()

SServerScanInfo::SServerScanInfo ( const TSkipServers skip_servers)
inline

Definition at line 100 of file reader_service.cpp.

Member Function Documentation

◆ Reset()

void SServerScanInfo::Reset ( void  )
inline

Definition at line 112 of file reader_service.cpp.

References m_CurrentServer, m_SkippedCount, and m_TotalCount.

Referenced by s_ScanInfoReset().

◆ SkipServer()

bool SServerScanInfo::SkipServer ( const SSERV_Info server)

Definition at line 121 of file reader_service.cpp.

References ITERATE, m_SkippedCount, m_SkipServers, m_TotalCount, and SERV_EqualInfo().

Referenced by s_ScanInfoGetNextInfo().

Member Data Documentation

◆ m_CurrentServer

const SSERV_Info* SServerScanInfo::m_CurrentServer

Definition at line 109 of file reader_service.cpp.

Referenced by Reset(), and s_ScanInfoGetNextInfo().

◆ m_SkippedCount

int SServerScanInfo::m_SkippedCount

Definition at line 108 of file reader_service.cpp.

Referenced by Reset(), and SkipServer().

◆ m_SkipServers

const TSkipServers& SServerScanInfo::m_SkipServers

Definition at line 110 of file reader_service.cpp.

Referenced by SkipServer().

◆ m_TotalCount

int SServerScanInfo::m_TotalCount

Definition at line 107 of file reader_service.cpp.

Referenced by Reset(), and SkipServer().


The documentation for this struct was generated from the following file:
Modified on Tue Nov 28 02:22:50 2023 by modify_doxy.py rev. 669887