NCBI C++ ToolKit
Public Member Functions | Protected Attributes | List of all members
CCassFetch Class Referenceabstract

Search Toolkit Book for CCassFetch

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

+ Inheritance diagram for CCassFetch:
+ Collaboration diagram for CCassFetch:

Public Member Functions

 CCassFetch ()
 
 CCassFetch (const string &client_id, const SCass_BlobId &blob_id)
 
virtual ~CCassFetch ()
 
virtual void ResetCallbacks (void)=0
 
virtual string Serialize (void) const =0
 
CCassBlobWaiter * GetLoader (void)
 
void SetReadFinished (void)
 
EPSGS_DbFetchType GetFetchType (void) const
 
bool ReadFinished (void) const
 
void SetInPeek (bool val)
 
bool InPeek (void) const
 
bool Canceled (void) const
 
void Cancel (void)
 
bool IsBlobFetch (void) const
 
SCass_BlobId GetBlobId (void) const
 
string GetClientId (void) const
 
void RemoveFromExcludeBlobCache (void)
 
EPSGS_CacheAddResult AddToExcludeBlobCache (bool &completed, psg_time_point_t &completed_time)
 
void SetExcludeBlobCacheUpdated (bool value)
 
void SetExcludeBlobCacheCompleted (void)
 

Protected Attributes

unique_ptr< CCassBlobWaiter > m_Loader
 
bool m_FinishedRead
 
bool m_InPeek
 
EPSGS_DbFetchType m_FetchType
 
bool m_Canceled
 
string m_ClientId
 
SCass_BlobId m_BlobId
 
bool m_ExcludeBlobCacheUpdated
 

Detailed Description

Definition at line 57 of file cass_fetch.hpp.

Constructor & Destructor Documentation

◆ CCassFetch() [1/2]

CCassFetch::CCassFetch ( )
inline

Definition at line 60 of file cass_fetch.hpp.

◆ CCassFetch() [2/2]

CCassFetch::CCassFetch ( const string &  client_id,
const SCass_BlobId &  blob_id 
)
inline

Definition at line 68 of file cass_fetch.hpp.

◆ ~CCassFetch()

virtual CCassFetch::~CCassFetch ( )
inlinevirtual

Definition at line 79 of file cass_fetch.hpp.

Member Function Documentation

◆ AddToExcludeBlobCache()

EPSGS_CacheAddResult CCassFetch::AddToExcludeBlobCache ( bool &  completed,
psg_time_point_t &  completed_time 
)

Definition at line 61 of file cass_fetch.cpp.

References ePSGS_Added, CPubseqGatewayApp::GetInstance(), IsBlobFetch(), m_BlobId, m_ClientId, m_ExcludeBlobCacheUpdated, SCass_BlobId::m_Sat, and SCass_BlobId::m_SatKey.

Referenced by CPSGS_CassBlobBase::x_CheckExcludeBlobCache().

◆ Cancel()

void CCassFetch::Cancel ( void  )
inline

Definition at line 107 of file cass_fetch.hpp.

◆ Canceled()

bool CCassFetch::Canceled ( void  ) const
inline

Definition at line 104 of file cass_fetch.hpp.

◆ GetBlobId()

SCass_BlobId CCassFetch::GetBlobId ( void  ) const
inline

Definition at line 124 of file cass_fetch.hpp.

Referenced by CPSGS_CassBlobBase::OnGetBlobChunk(), CPSGS_CassBlobBase::OnGetBlobProp(), CPSGS_TSEChunkProcessor::OnGetBlobProp(), CPSGS_Reply::PrepareBlobData(), CPSGS_Reply::PrepareBlobMessage(), CPSGS_Reply::PrepareBlobPropData(), CPSGS_CassBlobBase::x_BlobChunkCallback(), CPSGS_CassBlobBase::x_BlobErrorCallback(), CPSGS_CassBlobBase::x_BlobPropsCallback(), CPSGS_CassBlobBase::x_CheckExcludeBlobCache(), CPSGS_CassBlobBase::x_CheckId2Info(), CPSGS_CassBlobBase::x_GetId2ChunkNumber(), CPSGS_CassBlobBase::x_OnBlobPropNotFound(), CPSGS_CassBlobBase::x_OnBlobPropSlimTSE(), CPSGS_CassBlobBase::x_PrepareBlobExcluded(), CPSGS_CassBlobBase::x_PrepareBlobPropData(), CPSGS_CassBlobBase::x_RequestID2BlobChunks(), CPSGS_CassBlobBase::x_RequestId2SplitBlobs(), CPSGS_CassBlobBase::x_RequestMoreChunksForSmartTSE(), and CPSGS_CassBlobBase::x_RequestOriginalBlobChunks().

◆ GetClientId()

string CCassFetch::GetClientId ( void  ) const
inline

Definition at line 127 of file cass_fetch.hpp.

Referenced by CPSGS_CassBlobBase::x_CheckExcludeBlobCache(), CPSGS_CassBlobBase::x_RequestID2BlobChunks(), CPSGS_CassBlobBase::x_RequestId2SplitBlobs(), CPSGS_CassBlobBase::x_RequestMoreChunksForSmartTSE(), and CPSGS_CassBlobBase::x_RequestOriginalBlobChunks().

◆ GetFetchType()

EPSGS_DbFetchType CCassFetch::GetFetchType ( void  ) const
inline

Definition at line 92 of file cass_fetch.hpp.

Referenced by CPSGS_CassProcessorBase::CountError(), and CPSGS_CassBlobBase::x_OnBlobPropNotFound().

◆ GetLoader()

CCassBlobWaiter* CCassFetch::GetLoader ( void  )
inline

Definition at line 86 of file cass_fetch.hpp.

Referenced by CPSGS_AsyncBioseqInfoBase::x_OnBioseqInfo(), CPSGS_AsyncResolveBase::x_OnBioseqInfo(), CPSGS_AsyncBioseqInfoBase::x_OnBioseqInfoError(), CPSGS_AsyncResolveBase::x_OnBioseqInfoError(), CPSGS_AsyncBioseqInfoBase::x_OnBioseqInfoWithoutSeqIdType(), CPSGS_AsyncResolveBase::x_OnBioseqInfoWithoutSeqIdType(), CPSGS_AsyncResolveBase::x_OnSi2csiError(), and CPSGS_AsyncResolveBase::x_OnSi2csiRecord().

◆ InPeek()

bool CCassFetch::InPeek ( void  ) const
inline

Definition at line 101 of file cass_fetch.hpp.

◆ IsBlobFetch()

bool CCassFetch::IsBlobFetch ( void  ) const
inline

Definition at line 117 of file cass_fetch.hpp.

References ePSGS_AnnotationBlobFetch, ePSGS_BlobBySatSatKeyFetch, and ePSGS_BlobBySeqIdFetch.

Referenced by AddToExcludeBlobCache(), RemoveFromExcludeBlobCache(), SetExcludeBlobCacheCompleted(), and CPSGS_CassBlobBase::x_CheckExcludeBlobCache().

◆ ReadFinished()

bool CCassFetch::ReadFinished ( void  ) const
inline

Definition at line 95 of file cass_fetch.hpp.

◆ RemoveFromExcludeBlobCache()

void CCassFetch::RemoveFromExcludeBlobCache ( void  )

Definition at line 41 of file cass_fetch.cpp.

References CPubseqGatewayApp::GetInstance(), IsBlobFetch(), m_BlobId, m_ClientId, m_ExcludeBlobCacheUpdated, SCass_BlobId::m_Sat, and SCass_BlobId::m_SatKey.

Referenced by CPSGS_CassBlobBase::OnGetBlobError(), CPSGS_CassBlobBase::x_BlobChunkCallback(), CPSGS_CassBlobBase::x_BlobErrorCallback(), and CPSGS_CassBlobBase::x_OnBlobPropNotFound().

◆ ResetCallbacks()

virtual void CCassFetch::ResetCallbacks ( void  )
pure virtual

Implemented in CCassIPGFetch, CCassPublicCommentFetch, CCassSplitHistoryFetch, CCassSi2csiFetch, CCassBioseqInfoFetch, CCassBlobFetch, CCassAccVerHistoryFetch, and CCassNamedAnnotFetch.

◆ Serialize()

virtual string CCassFetch::Serialize ( void  ) const
pure virtual

Implemented in CCassIPGFetch, CCassPublicCommentFetch, CCassSplitHistoryFetch, CCassSi2csiFetch, CCassBioseqInfoFetch, CCassBlobFetch, CCassAccVerHistoryFetch, and CCassNamedAnnotFetch.

Referenced by CPSGS_CassProcessorBase::CountError().

◆ SetExcludeBlobCacheCompleted()

void CCassFetch::SetExcludeBlobCacheCompleted ( void  )

Definition at line 80 of file cass_fetch.cpp.

References CPubseqGatewayApp::GetInstance(), IsBlobFetch(), m_BlobId, m_ClientId, m_ExcludeBlobCacheUpdated, SCass_BlobId::m_Sat, and SCass_BlobId::m_SatKey.

◆ SetExcludeBlobCacheUpdated()

void CCassFetch::SetExcludeBlobCacheUpdated ( bool  value)
inline

Definition at line 134 of file cass_fetch.hpp.

References rapidjson::value.

Referenced by CPSGS_CassBlobBase::x_CheckExcludeBlobCache().

◆ SetInPeek()

void CCassFetch::SetInPeek ( bool  val)
inline

Definition at line 98 of file cass_fetch.hpp.

References val.

◆ SetReadFinished()

void CCassFetch::SetReadFinished ( void  )
inline

Definition at line 89 of file cass_fetch.hpp.

Referenced by CPSGS_AnnotProcessor::OnAnnotBlobProp(), CPSGS_CassBlobBase::OnGetBlobChunk(), CPSGS_TSEChunkProcessor::OnGetBlobChunk(), CPSGS_CassBlobBase::OnGetBlobError(), CPSGS_TSEChunkProcessor::OnGetBlobError(), CPSGS_CassBlobBase::OnGetBlobProp(), CPSGS_TSEChunkProcessor::OnGetBlobProp(), CPSGS_TSEChunkProcessor::OnGetSplitHistory(), CPSGS_TSEChunkProcessor::OnGetSplitHistoryError(), CPSGS_CassBlobBase::OnPublicComment(), CPSGS_CassBlobBase::OnPublicCommentError(), CPSGS_CassBlobBase::x_BlobChunkCallback(), CPSGS_CassBlobBase::x_BlobErrorCallback(), CPSGS_CassBlobBase::x_BlobPropsCallback(), CPSGS_AccessionVersionHistoryProcessor::x_OnAccVerHistData(), CPSGS_AccessionVersionHistoryProcessor::x_OnAccVerHistError(), CPSGS_AsyncBioseqInfoBase::x_OnBioseqInfo(), CPSGS_AsyncResolveBase::x_OnBioseqInfo(), CPSGS_AsyncBioseqInfoBase::x_OnBioseqInfoError(), CPSGS_AsyncResolveBase::x_OnBioseqInfoError(), CPSGS_AsyncBioseqInfoBase::x_OnBioseqInfoWithoutSeqIdType(), CPSGS_AsyncResolveBase::x_OnBioseqInfoWithoutSeqIdType(), CPSGS_CassBlobBase::x_OnBlobPropNoneTSE(), CPSGS_CassBlobBase::x_OnBlobPropNotFound(), CPSGS_CassBlobBase::x_OnBlobPropOrigTSE(), CPSGS_CassBlobBase::x_OnBlobPropSlimTSE(), CPSGS_CassBlobBase::x_OnBlobPropSmartTSE(), CPSGS_CassBlobBase::x_OnBlobPropWholeTSE(), CPSGS_IPGResolveProcessor::x_OnIPGResolveData(), CPSGS_IPGResolveProcessor::x_OnIPGResolveError(), CPSGS_AnnotProcessor::x_OnNamedAnnotData(), CPSGS_AnnotProcessor::x_OnNamedAnnotError(), CPSGS_AsyncResolveBase::x_OnSi2csiError(), and CPSGS_AsyncResolveBase::x_OnSi2csiRecord().

Member Data Documentation

◆ m_BlobId

SCass_BlobId CCassFetch::m_BlobId
protected

Definition at line 163 of file cass_fetch.hpp.

Referenced by AddToExcludeBlobCache(), RemoveFromExcludeBlobCache(), and SetExcludeBlobCacheCompleted().

◆ m_Canceled

bool CCassFetch::m_Canceled
protected

Definition at line 159 of file cass_fetch.hpp.

◆ m_ClientId

string CCassFetch::m_ClientId
protected

Definition at line 162 of file cass_fetch.hpp.

Referenced by AddToExcludeBlobCache(), RemoveFromExcludeBlobCache(), and SetExcludeBlobCacheCompleted().

◆ m_ExcludeBlobCacheUpdated

bool CCassFetch::m_ExcludeBlobCacheUpdated
protected

Definition at line 164 of file cass_fetch.hpp.

Referenced by AddToExcludeBlobCache(), RemoveFromExcludeBlobCache(), and SetExcludeBlobCacheCompleted().

◆ m_FetchType

EPSGS_DbFetchType CCassFetch::m_FetchType
protected

Definition at line 157 of file cass_fetch.hpp.

◆ m_FinishedRead

bool CCassFetch::m_FinishedRead
protected

Definition at line 148 of file cass_fetch.hpp.

◆ m_InPeek

bool CCassFetch::m_InPeek
protected

Definition at line 151 of file cass_fetch.hpp.

◆ m_Loader

unique_ptr<CCassBlobWaiter> CCassFetch::m_Loader
protected

Definition at line 145 of file cass_fetch.hpp.

Referenced by CCassNamedAnnotFetch::ResetCallbacks(), CCassAccVerHistoryFetch::ResetCallbacks(), CCassBlobFetch::ResetCallbacks(), CCassBioseqInfoFetch::ResetCallbacks(), CCassSi2csiFetch::ResetCallbacks(), CCassSplitHistoryFetch::ResetCallbacks(), CCassPublicCommentFetch::ResetCallbacks(), and CCassIPGFetch::ResetCallbacks().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.0
Modified on Fri Sep 20 14:58:21 2024 by modify_doxy.py rev. 669887