NCBI C++ ToolKit
Public Member Functions | Public Attributes | List of all members
ICache::SBlobAccessDescr Struct Reference

Search Toolkit Book for ICache::SBlobAccessDescr

BLOB access descriptor. More...

#include <util/cache/icache.hpp>

+ Collaboration diagram for ICache::SBlobAccessDescr:

Public Member Functions

 SBlobAccessDescr (char *buf_=0, size_t buf_size_=0)
 

Public Attributes

unique_ptr< IReaderreader
 
char * buf
 
size_t buf_size
 
size_t blob_size
 
bool blob_found
 
unsigned maximum_age
 Set to a non-zero value to return a version not older than the specified value. More...
 
unsigned actual_age
 If `maximum_age` is not zero, GetBlobAccess() will set this field to the actual blob version age upon return. More...
 
bool return_current_version_supported
 If TRUE, the ICache instance supports return_current_version. More...
 
bool return_current_version
 If TRUE, the `version` argument of GetBlobAccess() will be ignored and the `current_version` and `current_version_validity` fields of this structure will be set to the current version number and its validity. More...
 
TBlobVersion current_version
 If `return_current_version` is set, the current version number of the blob is stored in the `current_version` field. More...
 
EBlobVersionValidity current_version_validity
 If `return_current_version` is set, the `current_version_validity` field will contain the validity of the returned blob version. More...
 

Detailed Description

BLOB access descriptor.

Definition at line 331 of file icache.hpp.

Constructor & Destructor Documentation

◆ SBlobAccessDescr()

ICache::SBlobAccessDescr::SBlobAccessDescr ( char *  buf_ = 0,
size_t  buf_size_ = 0 
)
inline

Definition at line 333 of file icache.hpp.

Member Data Documentation

◆ actual_age

unsigned ICache::SBlobAccessDescr::actual_age

If `maximum_age` is not zero, GetBlobAccess() will set this field to the actual blob version age upon return.

Definition at line 359 of file icache.hpp.

Referenced by CNetICacheClient::GetBlobAccess().

◆ blob_found

bool ICache::SBlobAccessDescr::blob_found

◆ blob_size

size_t ICache::SBlobAccessDescr::blob_size

◆ buf

char* ICache::SBlobAccessDescr::buf

◆ buf_size

size_t ICache::SBlobAccessDescr::buf_size

◆ current_version

TBlobVersion ICache::SBlobAccessDescr::current_version

If `return_current_version` is set, the current version number of the blob is stored in the `current_version` field.

Definition at line 372 of file icache.hpp.

Referenced by CNetICacheClient::GetBlobAccess().

◆ current_version_validity

EBlobVersionValidity ICache::SBlobAccessDescr::current_version_validity

If `return_current_version` is set, the `current_version_validity` field will contain the validity of the returned blob version.

Definition at line 376 of file icache.hpp.

Referenced by CNetICacheClient::GetBlobAccess().

◆ maximum_age

unsigned ICache::SBlobAccessDescr::maximum_age

Set to a non-zero value to return a version not older than the specified value.

Definition at line 355 of file icache.hpp.

Referenced by CNetICacheClient::GetBlobAccess().

◆ reader

unique_ptr<IReader> ICache::SBlobAccessDescr::reader

◆ return_current_version

bool ICache::SBlobAccessDescr::return_current_version

If TRUE, the `version` argument of GetBlobAccess() will be ignored and the `current_version` and `current_version_validity` fields of this structure will be set to the current version number and its validity.

Definition at line 368 of file icache.hpp.

Referenced by CNetICacheClient::GetBlobAccess().

◆ return_current_version_supported

bool ICache::SBlobAccessDescr::return_current_version_supported

If TRUE, the ICache instance supports return_current_version.

Definition at line 362 of file icache.hpp.

Referenced by CNetICacheClient::GetBlobAccess().


The documentation for this struct was generated from the following file:
Modified on Tue Apr 16 20:12:46 2024 by modify_doxy.py rev. 669887