NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
CPoolBalancer Class Reference

Search Toolkit Book for CPoolBalancer

#include <corelib/ncbi_pool_balancer.hpp>

+ Inheritance diagram for CPoolBalancer:
+ Collaboration diagram for CPoolBalancer:

Classes

struct  SEndpointInfo
 

Public Types

enum  EFlags { fIgnoreRawIPs = 1 << 0 , fNoPooling = 1 << 1 }
 
- 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

 DECLARE_SAFE_FLAGS_TYPE (EFlags, TFlags)
 
 CPoolBalancer (const string &service_name, const IDBServiceMapper::TOptions &options, TFlags flags)
 
 CPoolBalancer (const string &service_name, const IDBServiceMapper::TOptions &options, bool ignore_raw_ips)
 
TSvrRef GetServer (void)
 
void LocallyPenalize (TSvrRef 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
 

Protected Types

typedef map< string, unsigned intTCounts
 

Protected Member Functions

void x_InitFromCounts (const TCounts &counts)
 
TSvrRef x_GetServer (const void *params, IBalanceable **conn)
 
bool x_NoPooling (void) const
 
virtual IBalanceablex_TryPool (const void *)
 
virtual unsigned int x_GetCount (const void *, const string &)
 
virtual unsigned int x_GetPoolMax (const void *)
 
virtual void x_Discard (const void *, IBalanceable *)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Private Types

typedef multimap< CEndpointKey, SEndpointInfoTEndpoints
 

Private Member Functions

CEndpointKey x_NameToKey (CTempString &name) const
 
TEndpoints::iterator x_FindEndpoint (CEndpointKey key, CTempString name)
 
TEndpoints::iterator x_FindEndpointAsIs (CEndpointKey key, CTempString name)
 

Private Attributes

string m_ServiceName
 
TEndpoints m_Endpoints
 
multiset< double > m_Rankings
 
unsigned int m_TotalCount
 
TFlags m_Flags
 

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

Detailed Description

Definition at line 52 of file ncbi_pool_balancer.hpp.

Member Typedef Documentation

◆ TCounts

typedef map<string, unsigned int> CPoolBalancer::TCounts
protected

Definition at line 79 of file ncbi_pool_balancer.hpp.

◆ TEndpoints

Definition at line 109 of file ncbi_pool_balancer.hpp.

Member Enumeration Documentation

◆ EFlags

Enumerator
fIgnoreRawIPs 
fNoPooling 

Definition at line 55 of file ncbi_pool_balancer.hpp.

Constructor & Destructor Documentation

◆ CPoolBalancer() [1/2]

CPoolBalancer::CPoolBalancer ( const string service_name,
const IDBServiceMapper::TOptions options,
TFlags  flags 
)

◆ CPoolBalancer() [2/2]

CPoolBalancer::CPoolBalancer ( const string service_name,
const IDBServiceMapper::TOptions options,
bool  ignore_raw_ips 
)
inline

Definition at line 65 of file ncbi_pool_balancer.hpp.

Member Function Documentation

◆ DECLARE_SAFE_FLAGS_TYPE()

CPoolBalancer::DECLARE_SAFE_FLAGS_TYPE ( EFlags  ,
TFlags   
)

◆ GetServer()

TSvrRef CPoolBalancer::GetServer ( void  )
inline

Definition at line 73 of file ncbi_pool_balancer.hpp.

References x_GetServer().

◆ LocallyPenalize()

void CPoolBalancer::LocallyPenalize ( TSvrRef  server)

◆ x_Discard()

virtual void CPoolBalancer::x_Discard ( const void *  ,
IBalanceable  
)
inlineprotectedvirtual

Reimplemented in CDBPoolBalancer.

Definition at line 93 of file ncbi_pool_balancer.hpp.

Referenced by x_GetServer().

◆ x_FindEndpoint()

CPoolBalancer::TEndpoints::iterator CPoolBalancer::x_FindEndpoint ( CEndpointKey  key,
CTempString  name 
)
private

◆ x_FindEndpointAsIs()

CPoolBalancer::TEndpoints::iterator CPoolBalancer::x_FindEndpointAsIs ( CEndpointKey  key,
CTempString  name 
)
private

◆ x_GetCount()

virtual unsigned int CPoolBalancer::x_GetCount ( const void *  ,
const string  
)
inlineprotectedvirtual

Reimplemented in CDBPoolBalancer.

Definition at line 88 of file ncbi_pool_balancer.hpp.

Referenced by x_GetServer().

◆ x_GetPoolMax()

virtual unsigned int CPoolBalancer::x_GetPoolMax ( const void *  )
inlineprotectedvirtual

Reimplemented in CDBPoolBalancer.

Definition at line 91 of file ncbi_pool_balancer.hpp.

Referenced by x_GetServer().

◆ x_GetServer()

TSvrRef CPoolBalancer::x_GetServer ( const void *  params,
IBalanceable **  conn 
)
protected

◆ x_InitFromCounts()

void CPoolBalancer::x_InitFromCounts ( const TCounts counts)
protected

◆ x_NameToKey()

CEndpointKey CPoolBalancer::x_NameToKey ( CTempString name) const
private

◆ x_NoPooling()

bool CPoolBalancer::x_NoPooling ( void  ) const
inlineprotected

◆ x_TryPool()

virtual IBalanceable* CPoolBalancer::x_TryPool ( const void *  )
inlineprotectedvirtual

Reimplemented in CDBPoolBalancer.

Definition at line 86 of file ncbi_pool_balancer.hpp.

Referenced by x_GetServer().

Member Data Documentation

◆ m_Endpoints

TEndpoints CPoolBalancer::m_Endpoints
private

◆ m_Flags

TFlags CPoolBalancer::m_Flags
private

Definition at line 120 of file ncbi_pool_balancer.hpp.

Referenced by x_InitFromCounts(), and x_NoPooling().

◆ m_Rankings

multiset<double> CPoolBalancer::m_Rankings
private

◆ m_ServiceName

string CPoolBalancer::m_ServiceName
private

Definition at line 116 of file ncbi_pool_balancer.hpp.

Referenced by x_GetServer(), and x_InitFromCounts().

◆ m_TotalCount

unsigned int CPoolBalancer::m_TotalCount
private

Definition at line 119 of file ncbi_pool_balancer.hpp.

Referenced by x_GetServer(), and x_InitFromCounts().


The documentation for this class was generated from the following files:
Modified on Wed Jun 12 11:15:44 2024 by modify_doxy.py rev. 669887