Search Toolkit Book for CLDS2_UrlHandler_Base

Base class for URL handler. More...

#include <objtools/lds2/lds2_handlers.hpp>

Inheritance diagram for CLDS2_UrlHandler_Base:

Collaboration diagram for CLDS2_UrlHandler_Base:

Public Member Functions
	CLDS2_UrlHandler_Base (const string &handler_name)
	Create a handler with the given name. More...

virtual	~CLDS2_UrlHandler_Base (void)

const string &	GetHandlerName (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...

virtual shared_ptr< CNcbiIstream >	OpenStream (const SLDS2_File &, Int8, CLDS2_Database *)=0
	Open input stream for the URL at the specified position. More...

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (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

Protected Member Functions
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...

virtual Int8	GetFileSize (const SLDS2_File &)
	Get file size - returns 0 by default. More...

virtual Uint4	GetFileCRC (const SLDS2_File &)
	Get file CRC - returns 0 by default. More...

virtual Int8	GetFileTime (const SLDS2_File &)
	Get file timestamp - returns 0 by default. More...

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Private Attributes
string	m_Name

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< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

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)

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

Base class for URL handler.

Definition at line 43 of file lds2_handlers.hpp.

Constructor & Destructor Documentation

◆ CLDS2_UrlHandler_Base()

CLDS2_UrlHandler_Base::CLDS2_UrlHandler_Base ( const string & handler_name )

inline

Create a handler with the given name.

Definition at line 47 of file lds2_handlers.hpp.

◆ ~CLDS2_UrlHandler_Base()

virtual CLDS2_UrlHandler_Base::~CLDS2_UrlHandler_Base ( void )

inlinevirtual

Definition at line 49 of file lds2_handlers.hpp.

Member Function Documentation

◆ FillInfo()

void CLDS2_UrlHandler_Base::FillInfo ( SLDS2_File & info )

virtual

Fill file/url information - crc, size, format etc.

'size' member must be set to >=0 if the file exists, negative values indicate non-existent files/urls which should be removed from the database. The default implementation uses GetXXXX methods to fill the information.

Definition at line 52 of file lds2_handlers.cpp.

References info.

◆ GetFileCRC()

virtual Uint4 CLDS2_UrlHandler_Base::GetFileCRC ( const SLDS2_File & )

inlineprotectedvirtual

Get file CRC - returns 0 by default.

Reimplemented in CLDS2_UrlHandler_File.

Definition at line 92 of file lds2_handlers.hpp.

◆ GetFileFormat()

SLDS2_File::TFormat CLDS2_UrlHandler_Base::GetFileFormat ( const SLDS2_File & file_info )

protectedvirtual

Methods for getting file information.

Most of this information (except format) is not critical and is used only to detect modifications and reindex file in the database if at least one field changes. Guess file format. The default implementation opens the stream (see OpenStream) and uses CFormatGuess on it.

Definition at line 62 of file lds2_handlers.cpp.

References CFormatGuess::eUnknown, CFormatGuess::Format(), in(), NULL, and OpenStream().

◆ GetFileSize()

virtual Int8 CLDS2_UrlHandler_Base::GetFileSize ( const SLDS2_File & )

inlineprotectedvirtual

Get file size - returns 0 by default.

Negative values are used to indicate non-existing files.

Reimplemented in CLDS2_UrlHandler_File.

Definition at line 90 of file lds2_handlers.hpp.

◆ GetFileTime()

virtual Int8 CLDS2_UrlHandler_Base::GetFileTime ( const SLDS2_File & )

inlineprotectedvirtual

Get file timestamp - returns 0 by default.

Reimplemented in CLDS2_UrlHandler_File.

Definition at line 94 of file lds2_handlers.hpp.

◆ GetHandlerName()

const string& CLDS2_UrlHandler_Base::GetHandlerName ( void ) const

inline

Get handler name.

Definition at line 52 of file lds2_handlers.hpp.

◆ OpenStream()

virtual shared_ptr<CNcbiIstream> CLDS2_UrlHandler_Base::OpenStream	(	const SLDS2_File &	,
		Int8	,
		CLDS2_Database *
	)

pure virtual

Open input stream for the URL at the specified position.

The stream will be deleted by the caller. Database is provided so that the handler can fetch information about chunks. Return NULL on error (e.g. the file does not exist).

Implemented in CLDS2_UrlHandler_GZipFile, and CLDS2_UrlHandler_File.

Referenced by GetFileFormat().

◆ SaveChunks()

virtual void CLDS2_UrlHandler_Base::SaveChunks	(	const SLDS2_File &	,
		CLDS2_Database &
	)

inlinevirtual

Save information about chunks for the URL in the database.

The default implementation does nothing.

Reimplemented in CLDS2_UrlHandler_GZipFile.

Definition at line 64 of file lds2_handlers.hpp.

◆ SetHandlerName()

void CLDS2_UrlHandler_Base::SetHandlerName ( const string & new_name )

inlineprotected

Allow to change handler name by derived classes.

Definition at line 78 of file lds2_handlers.hpp.

Referenced by CLDS2_UrlHandler_GZipFile::CLDS2_UrlHandler_GZipFile().

Member Data Documentation

◆ m_Name

string CLDS2_UrlHandler_Base::m_Name

private

Definition at line 97 of file lds2_handlers.hpp.

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

include/objtools/lds2/lds2_handlers.hpp
src/objtools/lds2/lds2_handlers.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CLDS2_UrlHandler_Base()

◆ ~CLDS2_UrlHandler_Base()

Member Function Documentation

◆ FillInfo()

◆ GetFileCRC()

◆ GetFileFormat()

◆ GetFileSize()

◆ GetFileTime()

◆ GetHandlerName()

◆ OpenStream()

◆ SaveChunks()

◆ SetHandlerName()

Member Data Documentation

◆ m_Name