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

Search Toolkit Book for CLDS2_UrlHandler_File

Default handler for local files - registered automatically by LDS2 manager and data loader. More...

#include <objtools/lds2/lds2_handlers.hpp>

+ Inheritance diagram for CLDS2_UrlHandler_File:
+ Collaboration diagram for CLDS2_UrlHandler_File:

Public Member Functions

 CLDS2_UrlHandler_File (void)
 
 ~CLDS2_UrlHandler_File (void) override
 
shared_ptr< CNcbiIstreamOpenStream (const SLDS2_File &file_info, Int8 stream_pos, CLDS2_Database *db) override
 Open input stream for the URL at the specified position. More...
 
- Public Member Functions inherited from CLDS2_UrlHandler_Base
 CLDS2_UrlHandler_Base (const string &handler_name)
 Create a handler with the given name. More...
 
virtual ~CLDS2_UrlHandler_Base (void)
 
const stringGetHandlerName (void) const
 Get handler name. More...
 
virtual void FillInfo (SLDS2_File &info)
 Fill file/url information - crc, size, format etc. More...
 
virtual void SaveChunks (const SLDS2_File &, CLDS2_Database &)
 Save information about chunks for the URL in the database. More...
 
- 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
 

Static Public Member Functions

static const string s_GetHandlerName (void)
 
- 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)
 

Protected Member Functions

Int8 GetFileSize (const SLDS2_File &file_info) override
 Get file size - returns 0 by default. More...
 
Uint4 GetFileCRC (const SLDS2_File &file_info) override
 Get file CRC - returns 0 by default. More...
 
Int8 GetFileTime (const SLDS2_File &file_info) override
 Get file timestamp - returns 0 by default. More...
 
shared_ptr< CNcbiIstreamOpenOrGetStream (const SLDS2_File &file_info)
 
- Protected Member Functions inherited from CLDS2_UrlHandler_Base
void SetHandlerName (const string &new_name)
 Allow to change handler name by derived classes. More...
 
virtual SLDS2_File::TFormat GetFileFormat (const SLDS2_File &file_info)
 Methods for getting file information. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Private Types

typedef shared_ptr< CNcbiIstreamTStream
 
typedef pair< string, TStreamTNamedStream
 
typedef deque< TNamedStreamTStreamCache
 

Private Member Functions

TStreamCachex_GetStreamCache (void)
 

Private Attributes

CRef< CTls< TStreamCache > > m_StreamCache
 

Additional Inherited Members

- 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...
 
- 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

Default handler for local files - registered automatically by LDS2 manager and data loader.

Definition at line 103 of file lds2_handlers.hpp.

Member Typedef Documentation

◆ TNamedStream

Definition at line 127 of file lds2_handlers.hpp.

◆ TStream

typedef shared_ptr<CNcbiIstream> CLDS2_UrlHandler_File::TStream
private

Definition at line 126 of file lds2_handlers.hpp.

◆ TStreamCache

Definition at line 128 of file lds2_handlers.hpp.

Constructor & Destructor Documentation

◆ CLDS2_UrlHandler_File()

CLDS2_UrlHandler_File::CLDS2_UrlHandler_File ( void  )

Definition at line 80 of file lds2_handlers.cpp.

◆ ~CLDS2_UrlHandler_File()

CLDS2_UrlHandler_File::~CLDS2_UrlHandler_File ( void  )
inlineoverride

Definition at line 107 of file lds2_handlers.hpp.

Member Function Documentation

◆ GetFileCRC()

Uint4 CLDS2_UrlHandler_File::GetFileCRC ( const SLDS2_File )
overrideprotectedvirtual

Get file CRC - returns 0 by default.

Reimplemented from CLDS2_UrlHandler_Base.

Definition at line 110 of file lds2_handlers.cpp.

References CChecksum::AddFile(), CChecksum::eCRC32, CChecksum::GetChecksum(), and SLDS2_File::name.

◆ GetFileSize()

Int8 CLDS2_UrlHandler_File::GetFileSize ( const SLDS2_File )
overrideprotectedvirtual

Get file size - returns 0 by default.

Negative values are used to indicate non-existing files.

Reimplemented from CLDS2_UrlHandler_Base.

Definition at line 103 of file lds2_handlers.cpp.

References f(), and SLDS2_File::name.

◆ GetFileTime()

Int8 CLDS2_UrlHandler_File::GetFileTime ( const SLDS2_File )
overrideprotectedvirtual

Get file timestamp - returns 0 by default.

Reimplemented from CLDS2_UrlHandler_Base.

Definition at line 118 of file lds2_handlers.cpp.

References f(), CDirEntry::SStat::mtime_nsec, and SLDS2_File::name.

◆ OpenOrGetStream()

shared_ptr< CNcbiIstream > CLDS2_UrlHandler_File::OpenOrGetStream ( const SLDS2_File file_info)
protected

◆ OpenStream()

shared_ptr< CNcbiIstream > CLDS2_UrlHandler_File::OpenStream ( const SLDS2_File file_info,
Int8  stream_pos,
CLDS2_Database db 
)
overridevirtual

Open input stream for the URL at the specified position.

The stream will be deleted by the caller.

Implements CLDS2_UrlHandler_Base.

Reimplemented in CLDS2_UrlHandler_GZipFile.

Definition at line 88 of file lds2_handlers.cpp.

References in(), NcbiInt8ToStreampos(), and OpenOrGetStream().

◆ s_GetHandlerName()

const string CLDS2_UrlHandler_File::s_GetHandlerName ( void  )
static

Definition at line 74 of file lds2_handlers.cpp.

Referenced by CLDS2_Manager::x_GetUrlHandler().

◆ x_GetStreamCache()

CLDS2_UrlHandler_File::TStreamCache & CLDS2_UrlHandler_File::x_GetStreamCache ( void  )
private

Definition at line 126 of file lds2_handlers.cpp.

References CTls< TValue >::GetValue(), m_StreamCache, and CTls< TValue >::SetValue().

Referenced by OpenOrGetStream().

Member Data Documentation

◆ m_StreamCache

CRef<CTls<TStreamCache> > CLDS2_UrlHandler_File::m_StreamCache
private

Definition at line 132 of file lds2_handlers.hpp.

Referenced by x_GetStreamCache().


The documentation for this class was generated from the following files:
Modified on Wed Jun 19 17:01:32 2024 by modify_doxy.py rev. 669887