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

Search Toolkit Book for CRmtFileStatus

#include <gui/utils/rmtfilestatus.hpp>

+ Collaboration diagram for CRmtFileStatus:

Public Types

enum  ESuggestedAction { ESuggestedAction_Access , ESuggestedAction_Skip }

Static Public Member Functions

static ESuggestedAction Check (const string &sKey)
static void Set (const string &sKey, ESuggestedAction KnownAccessibility)

Private Types

typedef size_t TCounter
typedef time_t TTimeStamp
 in seconds More...

Static Private Member Functions

static CNetICacheClientx_Init ()
static bool x_Read (CNetICacheClient *cache, const string &sNCKey, int version, const string &sSubKey, void *data, size_t data_size)
static void x_ResetSkipLimits (const string &sNCKey)
static string x_KeyToNCKey (const string &sKey)

Static Private Attributes

static unique_ptr< CNetICacheClientm_pCacheClient
static TCounter m_MaxCount
static TTimeStamp m_MaxCheckInterval
static bool m_isStatusNotAvailable

Detailed Description

Definition at line 44 of file rmtfilestatus.hpp.

Member Typedef Documentation

◆ TCounter

typedef size_t CRmtFileStatus::TCounter

Definition at line 58 of file rmtfilestatus.hpp.

◆ TTimeStamp

typedef time_t CRmtFileStatus::TTimeStamp

in seconds

Definition at line 60 of file rmtfilestatus.hpp.

Member Enumeration Documentation

◆ ESuggestedAction


try to access the remote file


do not access the file

Definition at line 46 of file rmtfilestatus.hpp.

Member Function Documentation

◆ Check()

CRmtFileStatus::ESuggestedAction CRmtFileStatus::Check ( const string sKey)

◆ Set()

void CRmtFileStatus::Set ( const string sKey,
CRmtFileStatus::ESuggestedAction  KnownAccessibility 

◆ x_Init()

CNetICacheClient * CRmtFileStatus::x_Init ( void  )

◆ x_KeyToNCKey()

string CRmtFileStatus::x_KeyToNCKey ( const string sKey)

Definition at line 187 of file rmtfilestatus.cpp.

References CChecksum::AddLine(), CChecksum::eMD5, CChecksumBase::GetResultHex(), and result.

Referenced by Check(), and Set().

◆ x_Read()

bool CRmtFileStatus::x_Read ( CNetICacheClient cache,
const string sNCKey,
int  version,
const string sSubKey,
void *  data,
size_t  data_size 

Definition at line 78 of file rmtfilestatus.cpp.

References data, and version.

Referenced by Check(), and Set().

◆ x_ResetSkipLimits()

void CRmtFileStatus::x_ResetSkipLimits ( const string sNCKey)

Definition at line 90 of file rmtfilestatus.cpp.

References NULL, and x_Init().

Referenced by Check(), and Set().

Member Data Documentation

◆ m_isStatusNotAvailable

bool CRmtFileStatus::m_isStatusNotAvailable

Definition at line 76 of file rmtfilestatus.hpp.

Referenced by x_Init().

◆ m_MaxCheckInterval

CRmtFileStatus::TTimeStamp CRmtFileStatus::m_MaxCheckInterval

Definition at line 72 of file rmtfilestatus.hpp.

Referenced by Check(), and x_Init().

◆ m_MaxCount

CRmtFileStatus::TCounter CRmtFileStatus::m_MaxCount

Definition at line 69 of file rmtfilestatus.hpp.

Referenced by Check(), and x_Init().

◆ m_pCacheClient

unique_ptr< CNetICacheClient > CRmtFileStatus::m_pCacheClient

Definition at line 61 of file rmtfilestatus.hpp.

Referenced by x_Init().

The documentation for this class was generated from the following files:
Modified on Fri Apr 12 17:17:45 2024 by rev. 669887