Downloads original file into a single file on local disk. Handles read requests as they come along. More...

#include <XrdFileCacheIOEntireFile.hh>

Inheritance diagram for XrdFileCache::IOEntireFile:

[legend]

Collaboration diagram for XrdFileCache::IOEntireFile:

[legend]

Public Member Functions
	IOEntireFile (XrdOucCacheIO2 *io, XrdOucCacheStats &stats, Cache &cache)
	Constructor. More...

	~IOEntireFile ()
	Destructor. More...

bool	HasFile () const
	Check if File was opened successfully. More...

virtual int	Read (char *Buffer, long long Offset, int Length)

virtual int	ReadV (const XrdOucIOVec *readV, int n)

virtual XrdOucCacheIO *	Detach ()

virtual bool	ioActive ()
	Virtual method of XrdOucCacheIO. Called to check if destruction needs to be done in a separate task. More...

virtual int	Fstat (struct stat &sbuff)

virtual long long	FSize ()

virtual void	Read (XrdOucCacheIOCB &iocb, char *buff, long long offs, int rlen)

virtual void	ReadV (XrdOucCacheIOCB &iocb, const XrdOucIOVec *readV, int rnum)

Public Member Functions inherited from XrdFileCache::IO
	IO (XrdOucCacheIO2 *io, XrdOucCacheStats &stats, Cache &cache)

virtual XrdOucCacheIO *	Base ()
	Original data source. More...

virtual const char *	Path ()
	Original data source URL. More...

virtual int	Sync ()

virtual int	Trunc (long long Offset)

virtual int	Write (char *Buffer, long long Offset, int Length)

virtual void	Update (XrdOucCacheIO2 &iocp)

XrdSysTrace *	GetTrace ()

XrdOucCacheIO2 *	GetInput ()

virtual void	Sync (XrdOucCacheIOCB &iocb)

virtual void	Write (XrdOucCacheIOCB &iocb, char *buff, long long offs, int wlen)

Public Member Functions inherited from XrdOucCacheIO2
virtual int	Fstat (struct stat &sbuff)

virtual const char *	Location ()

virtual void	Read (XrdOucCacheIOCB &iocb, char *buff, long long offs, int rlen)

virtual void	ReadV (XrdOucCacheIOCB &iocb, const XrdOucIOVec *readV, int rnum)

virtual void	Sync (XrdOucCacheIOCB &iocb)

virtual void	Update (XrdOucCacheIO2 &iocp)

virtual void	Write (XrdOucCacheIOCB &iocb, char *buff, long long offs, int wlen)

virtual	~XrdOucCacheIO2 ()

virtual int	Read (char *Buffer, long long Offset, int Length)=0

virtual int	ReadV (const XrdOucIOVec *readV, int n)

virtual int	Sync ()=0

virtual int	Write (char *Buffer, long long Offset, int Length)=0

Public Member Functions inherited from XrdOucCacheIO
virtual long long	FSize ()=0

virtual const char *	Path ()=0

virtual int	Read (char *Buffer, long long Offset, int Length)=0

virtual int	ReadV (const XrdOucIOVec *readV, int n)

virtual int	Sync ()=0

virtual int	Trunc (long long Offset)=0

virtual int	Write (char *Buffer, long long Offset, int Length)=0

virtual XrdOucCacheIO *	Base ()

virtual XrdOucCacheIO *	Detach ()

virtual bool	ioActive ()

virtual void	Preread (long long Offset, int Length, int Opts=0)

virtual void	Preread (aprParms &Parms)

virtual	~XrdOucCacheIO ()

Private Member Functions
int	initCachedStat (const char *path)

Private Attributes
XrdSysMutex	m_mutex

File *	m_file

struct stat *	m_localStat

Additional Inherited Members
Public Attributes inherited from XrdOucCacheIO
XrdOucCacheStats	Statistics

Static Public Attributes inherited from XrdOucCacheIO
static const int	SingleUse = 0x0001

Protected Member Functions inherited from XrdFileCache::IO
const char *	GetPath ()

Protected Attributes inherited from XrdFileCache::IO
XrdOucCacheStats &	m_statsGlobal
	reference to Cache statistics More...

Cache &	m_cache
	reference to Cache needed in detach More...

const char *	m_traceID

std::string	m_path

Detailed Description

Downloads original file into a single file on local disk. Handles read requests as they come along.

Constructor & Destructor Documentation

◆ IOEntireFile()

XrdFileCache::IOEntireFile::IOEntireFile	(	XrdOucCacheIO2 *	io,
		XrdOucCacheStats &	stats,
		Cache &	cache
	)

Constructor.

◆ ~IOEntireFile()

XrdFileCache::IOEntireFile::~IOEntireFile ( )

Destructor.

Member Function Documentation

◆ Detach()

virtual XrdOucCacheIO * XrdFileCache::IOEntireFile::Detach ( )

virtual

Detach itself from Cache. Note: this will delete the object.

Returns: original source XrdPosixFile

Reimplemented from XrdOucCacheIO.

◆ FSize()

virtual long long XrdFileCache::IOEntireFile::FSize ( )

virtual

Implements XrdOucCacheIO.

◆ Fstat()

virtual int XrdFileCache::IOEntireFile::Fstat ( struct stat & sbuff )

virtual

Perform an fstat() operation (defaults to passthrough).

Parameters

sbuff reference to the stat buffer to be filled in. Only fields st_size, st_blocks, st_mtime (st_atime and st_ctime may be set to st_mtime), st_ino, and st_mode need to be set. All other fields are preset and should not be changed.

Returns: <0 - fstat failed, value is -errno. =0 - fstat succeeded, sbuff holds stat information. >0 - fstat could not be done, forward operation to next level.

Reimplemented from XrdOucCacheIO2.

◆ HasFile()

bool XrdFileCache::IOEntireFile::HasFile ( ) const

inline

Check if File was opened successfully.

References m_file.

◆ initCachedStat()

int XrdFileCache::IOEntireFile::initCachedStat ( const char * path )

private

◆ ioActive()

virtual bool XrdFileCache::IOEntireFile::ioActive ( )

virtual

Virtual method of XrdOucCacheIO. Called to check if destruction needs to be done in a separate task.

Reimplemented from XrdOucCacheIO.

◆ Read() [1/2]

virtual int XrdFileCache::IOEntireFile::Read	(	char *	Buffer,
		long long	Offset,
		int	Length
	)

virtual

Implements XrdOucCacheIO.

◆ Read() [2/2]

virtual void XrdOucCacheIO2::Read	(	XrdOucCacheIOCB &	iocb,
		char *	buff,
		long long	offs,
		int	rlen
	)

inlinevirtual

Pass Read request to the corresponding File object.

Parameters

Buffer
Offset
Length

Returns: number of bytes read

Reimplemented from XrdOucCacheIO2.

◆ ReadV() [1/2]

virtual int XrdFileCache::IOEntireFile::ReadV	(	const XrdOucIOVec *	readV,
		int	n
	)

virtual

Reimplemented from XrdOucCacheIO.

◆ ReadV() [2/2]

virtual void XrdOucCacheIO2::ReadV	(	XrdOucCacheIOCB &	iocb,
		const XrdOucIOVec *	readV,
		int	rnum
	)

inlinevirtual

Pass ReadV request to the corresponding File object.

Parameters

readV
n	number of XrdOucIOVecs

Returns: total bytes read

Reimplemented from XrdOucCacheIO2.

Member Data Documentation

◆ m_file

File* XrdFileCache::IOEntireFile::m_file

private

Referenced by HasFile().

◆ m_localStat

struct stat* XrdFileCache::IOEntireFile::m_localStat

private

◆ m_mutex

XrdSysMutex XrdFileCache::IOEntireFile::m_mutex

private

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

XrdFileCacheIOEntireFile.hh

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IOEntireFile()

◆ ~IOEntireFile()

Member Function Documentation

◆ Detach()

◆ FSize()

◆ Fstat()

◆ HasFile()

◆ initCachedStat()

◆ ioActive()

◆ Read() [1/2]

◆ Read() [2/2]

◆ ReadV() [1/2]

◆ ReadV() [2/2]

Member Data Documentation

◆ m_file

◆ m_localStat

◆ m_mutex