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 CNetICacheClient *	x_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< CNetICacheClient >	m_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

private

Definition at line 58 of file rmtfilestatus.hpp.

TTimeStamp

typedef time_t CRmtFileStatus::TTimeStamp

private

in seconds

Definition at line 60 of file rmtfilestatus.hpp.

Member Enumeration Documentation

ESuggestedAction

enum CRmtFileStatus::ESuggestedAction

Enumerator
ESuggestedAction_Access	try to access the remote file
ESuggestedAction_Skip	do not access the file

Definition at line 46 of file rmtfilestatus.hpp.

Member Function Documentation

Check()

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

static

Definition at line 106 of file rmtfilestatus.cpp.

References ESuggestedAction_Access, ESuggestedAction_Skip, LOG_POST, m_MaxCheckInterval, m_MaxCount, NULL, Warning(), x_Init(), x_KeyToNCKey(), x_Read(), and x_ResetSkipLimits().

Referenced by s_GetBigBedFeats(), s_GetBigBedSummary(), s_GetData(), and CWigGraph::x_GetBigWigSummary().

Set()

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

static

Definition at line 166 of file rmtfilestatus.cpp.

References ESuggestedAction_Access, ESuggestedAction_Skip, LOG_POST, Warning(), x_Init(), x_KeyToNCKey(), x_Read(), and x_ResetSkipLimits().

Referenced by s_GetBigBedFeats(), s_GetBigBedSummary(), s_GetData(), and CWigGraph::x_GetBigWigSummary().

x_Init()

CNetICacheClient * CRmtFileStatus::x_Init ( void  )

staticprivate

Definition at line 46 of file rmtfilestatus.cpp.

References CNcbiApplicationAPI::GetConfig(), IRegistry::GetInt(), IRegistry::GetString(), CNcbiApplication::Instance(), m_isStatusNotAvailable, m_MaxCheckInterval, m_MaxCount, m_pCacheClient, and NULL.

Referenced by Check(), Set(), and x_ResetSkipLimits().

x_KeyToNCKey()

string CRmtFileStatus::x_KeyToNCKey ( const string &  sKey )

staticprivate

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  )

staticprivate

Definition at line 78 of file rmtfilestatus.cpp.

References data, and dtl::version.

Referenced by Check(), and Set().

x_ResetSkipLimits()

void CRmtFileStatus::x_ResetSkipLimits ( const string &  sNCKey )

staticprivate

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

staticprivate

Definition at line 76 of file rmtfilestatus.hpp.

Referenced by x_Init().

m_MaxCheckInterval

CRmtFileStatus::TTimeStamp CRmtFileStatus::m_MaxCheckInterval

staticprivate

Definition at line 72 of file rmtfilestatus.hpp.

Referenced by Check(), and x_Init().

m_MaxCount

CRmtFileStatus::TCounter CRmtFileStatus::m_MaxCount

staticprivate

Definition at line 69 of file rmtfilestatus.hpp.

Referenced by Check(), and x_Init().

m_pCacheClient

unique_ptr< CNetICacheClient > CRmtFileStatus::m_pCacheClient

staticprivate

Definition at line 61 of file rmtfilestatus.hpp.

Referenced by x_Init().

---

The documentation for this class was generated from the following files:

• include/gui/utils/rmtfilestatus.hpp
• src/gui/utils/rmtfilestatus.cpp