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

Search Toolkit Book for COSGCaller

#include "osg_caller.hpp"
(Private to src/app/pubseq_gateway/server.)

+ Inheritance diagram for COSGCaller:
+ Collaboration diagram for COSGCaller:

Public Types

typedef vector< CRef< COSGFetch > > TFetches
- 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

 COSGCaller ()
 COSGCaller (const CRef< COSGConnectionPool > &connection_pool, const CRef< CRequestContext > &context, const TFetches &fetches)
virtual ~COSGCaller ()
void AllocateConnection (const CRef< COSGConnectionPool > &connection_pool)
void ReleaseConnection ()
void SendRequest (CPSGS_OSGProcessorBase &processor)
void WaitForReplies (CPSGS_OSGProcessorBase &processor)
const CID2_Request_PacketGetRequestPacket () const
size_t GetConnectionID () const
- 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 Member Functions

const CRef< COSGConnection > & GetConnection () const
CRef< CID2_RequestMakeInitRequest ()
void AddFetch (CID2_Request_Packet &packet, const CRef< COSGFetch > &fetch)
CRef< CID2_Request_PacketMakePacket (const TFetches &fetches)
size_t GetRequestIndex (const CID2_Reply &reply) const
bool EndOfReplies (const CID2_Reply &reply) const
bool EndOfReplies (size_t index) const
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...

Private Attributes

CRef< COSGConnectionPoolm_ConnectionPool
CRef< COSGConnectionm_Connection
CRef< CID2_Request_Packetm_RequestPacket
vector< CRef< COSGFetch > > m_Fetches

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 62 of file osg_caller.hpp.

Member Typedef Documentation

◆ TFetches

typedef vector<CRef<COSGFetch> > COSGCaller::TFetches

Definition at line 65 of file osg_caller.hpp.

Constructor & Destructor Documentation

◆ COSGCaller() [1/2]

COSGCaller::COSGCaller ( )

Definition at line 55 of file osg_caller.cpp.

◆ COSGCaller() [2/2]

COSGCaller::COSGCaller ( const CRef< COSGConnectionPool > &  connection_pool,
const CRef< CRequestContext > &  context,
const TFetches fetches 

◆ ~COSGCaller()

COSGCaller::~COSGCaller ( )

Definition at line 60 of file osg_caller.cpp.

Member Function Documentation

◆ AddFetch()

void COSGCaller::AddFetch ( CID2_Request_Packet packet,
const CRef< COSGFetch > &  fetch 

◆ AllocateConnection()

void COSGCaller::AllocateConnection ( const CRef< COSGConnectionPool > &  connection_pool)

◆ EndOfReplies() [1/2]

bool COSGCaller::EndOfReplies ( const CID2_Reply reply) const

Referenced by GetRequestIndex(), and WaitForReplies().

◆ EndOfReplies() [2/2]

bool COSGCaller::EndOfReplies ( size_t  index) const

◆ GetConnection()

const CRef<COSGConnection>& COSGCaller::GetConnection ( void  ) const

Definition at line 86 of file osg_caller.hpp.

References m_Connection.

◆ GetConnectionID()

size_t COSGCaller::GetConnectionID ( ) const

Definition at line 142 of file osg_caller.cpp.

References COSGConnection::GetConnectionID(), and m_Connection.

Referenced by CPSGS_OSGProcessorBase::DoProcess().

◆ GetRequestIndex()

size_t COSGCaller::GetRequestIndex ( const CID2_Reply reply) const

◆ GetRequestPacket()

const CID2_Request_Packet& COSGCaller::GetRequestPacket ( ) const

Definition at line 78 of file osg_caller.hpp.

References m_RequestPacket.

Referenced by CPSGS_OSGProcessorBase::DoProcess().

◆ MakeInitRequest()

CRef< CID2_Request > COSGCaller::MakeInitRequest ( )

Definition at line 65 of file osg_caller.cpp.

References CID2_Request_Base::SetParams(), and CID2_Request_Base::SetRequest().

Referenced by MakePacket().

◆ MakePacket()

CRef< CID2_Request_Packet > COSGCaller::MakePacket ( const TFetches fetches)

◆ ReleaseConnection()

void COSGCaller::ReleaseConnection ( )

◆ SendRequest()

void COSGCaller::SendRequest ( CPSGS_OSGProcessorBase processor)

◆ WaitForReplies()

void COSGCaller::WaitForReplies ( CPSGS_OSGProcessorBase processor)

Member Data Documentation

◆ m_Connection

CRef<COSGConnection> COSGCaller::m_Connection

◆ m_ConnectionPool

CRef<COSGConnectionPool> COSGCaller::m_ConnectionPool

Definition at line 100 of file osg_caller.hpp.

Referenced by AllocateConnection(), and ReleaseConnection().

◆ m_Fetches

vector<CRef<COSGFetch> > COSGCaller::m_Fetches

Definition at line 103 of file osg_caller.hpp.

Referenced by AddFetch(), GetRequestIndex(), MakePacket(), and WaitForReplies().

◆ m_RequestPacket

CRef<CID2_Request_Packet> COSGCaller::m_RequestPacket

Definition at line 102 of file osg_caller.hpp.

Referenced by GetRequestIndex(), GetRequestPacket(), SendRequest(), and WaitForReplies().

The documentation for this class was generated from the following files:
Modified on Wed Nov 29 02:16:17 2023 by rev. 669887