XFILE::CFileCache Class Reference

#include <FileCache.h>

Inheritance diagram for XFILE::CFileCache:

Public Member Functions
	CFileCache (const unsigned int flags)
	CFileCache (CCacheStrategy *pCache, bool bDeleteCache=true)
	~CFileCache () override
void	SetCacheStrategy (CCacheStrategy *pCache, bool bDeleteCache=true)
void	Process () override
void	OnExit () override
void	StopThread (bool bWait=true) override
bool	Open (const CURL &url) override
void	Close () override
bool	Exists (const CURL &url) override
int	Stat (const CURL &url, struct __stat64 *buffer) override
ssize_t	Read (void *lpBuf, size_t uiBufSize) override
int64_t	Seek (int64_t iFilePosition, int iWhence) override
int64_t	GetPosition () override
int64_t	GetLength () override
int	IoControl (EIoControl request, void *param) override
IFile *	GetFileImp ()
const std::string	GetProperty (XFILE::FileProperty type, const std::string &name="") const override
virtual const std::vector< std::string >	GetPropertyValues (XFILE::FileProperty type, const std::string &name="") const override
Public Member Functions inherited from XFILE::IFile
	IFile ()
virtual	~IFile ()
virtual bool	OpenForWrite (const CURL &url, bool bOverWrite=false)
virtual bool	ReOpen (const CURL &url)
virtual int	Stat (struct __stat64 *buffer)
virtual ssize_t	Write (const void *bufPtr, size_t bufSize)
virtual bool	ReadString (char *szLine, int iLineLength)
virtual void	Flush ()
virtual int	Truncate (int64_t size)
virtual int	GetChunkSize ()
virtual double	GetDownloadSpeed ()
virtual bool	Delete (const CURL &url)
virtual bool	Rename (const CURL &url, const CURL &urlnew)
virtual bool	SetHidden (const CURL &url, bool hidden)
Public Member Functions inherited from CThread
	CThread (IRunnable *pRunnable, const char *ThreadName)
virtual	~CThread ()
void	Create (bool bAutoDelete=false, unsigned stacksize=0)
void	Sleep (unsigned int milliseconds)
int	GetSchedRRPriority (void)
bool	SetPrioritySched_RR (int iPriority)
bool	IsAutoDelete () const
bool	IsRunning () const
bool	IsCurrentThread () const
int	GetMinPriority (void)
int	GetMaxPriority (void)
int	GetNormalPriority (void)
int	GetPriority (void)
bool	SetPriority (const int iPriority)
bool	WaitForThreadExit (unsigned int milliseconds)
float	GetRelativeUsage ()
int64_t	GetAbsoluteUsage ()
virtual void	OnException ()

Additional Inherited Members
Static Public Member Functions inherited from CThread
static bool	IsCurrentThread (const ThreadIdentifier tid)
static ThreadIdentifier	GetCurrentThreadId ()
static CThread *	GetCurrentThread ()
Protected Types inherited from CThread
enum	WaitResponse { WAIT_INTERRUPTED = -1, WAIT_SIGNALED = 0, WAIT_TIMEDOUT = 1 }
Protected Member Functions inherited from CThread
	CThread (const char *ThreadName)
virtual void	OnStartup ()
WaitResponse	AbortableWait (CEvent &event, int timeoutMillis=-1)
Protected Attributes inherited from CThread
std::atomic< bool >	m_bStop

Constructor & Destructor Documentation

CFileCache() [1/2]

CFileCache::CFileCache ( const unsigned int  flags )

explicit

CFileCache() [2/2]

CFileCache::CFileCache	(	CCacheStrategy *	pCache,
		bool	bDeleteCache = true
	)

~CFileCache()

CFileCache::~CFileCache ( )

override

Member Function Documentation

Close()

void CFileCache::Close ( void  )

overridevirtual

Implements XFILE::IFile.

Exists()

bool CFileCache::Exists ( const CURL &  url )

overridevirtual

Implements XFILE::IFile.

GetFileImp()

IFile * CFileCache::GetFileImp

(

)

GetLength()

int64_t CFileCache::GetLength ( )

overridevirtual

Implements XFILE::IFile.

GetPosition()

int64_t CFileCache::GetPosition ( )

overridevirtual

Implements XFILE::IFile.

GetProperty()

const std::string CFileCache::GetProperty ( XFILE::FileProperty  type, const std::string &  name = ""  ) const

overridevirtual

Reimplemented from XFILE::IFile.

GetPropertyValues()

virtual const std::vector<std::string> XFILE::CFileCache::GetPropertyValues ( XFILE::FileProperty  type, const std::string &  name = ""  ) const

inlineoverridevirtual

Reimplemented from XFILE::IFile.

IoControl()

int CFileCache::IoControl ( EIoControl  request, void *  param  )

overridevirtual

Reimplemented from XFILE::IFile.

OnExit()

void CFileCache::OnExit ( )

overridevirtual

Reimplemented from CThread.

Open()

bool CFileCache::Open ( const CURL &  url )

overridevirtual

Implements XFILE::IFile.

Process()

void CFileCache::Process ( void  )

overridevirtual

Reimplemented from CThread.

Read()

ssize_t CFileCache::Read ( void *  bufPtr, size_t  bufSize  )

overridevirtual

Attempt to read bufSize bytes from currently opened file into buffer bufPtr.

Parameters

bufPtr	pointer to buffer
bufSize	size of the buffer

Returns

number of successfully read bytes if any bytes were read and stored in buffer, zero if no bytes are available to read (end of file was reached) or undetectable error occur, -1 in case of any explicit error

Implements XFILE::IFile.

Seek()

int64_t CFileCache::Seek ( int64_t  iFilePosition, int  iWhence  )

overridevirtual

Implements XFILE::IFile.

SetCacheStrategy()

void CFileCache::SetCacheStrategy	(	CCacheStrategy *	pCache,
		bool	bDeleteCache = true
	)

Stat()

int CFileCache::Stat ( const CURL &  url, struct __stat64 *  buffer  )

overridevirtual

Fills struct __stat64 with information about file specified by url. For st_mode function will set correctly _S_IFDIR (directory) flag and may set _S_IREAD (read permission), _S_IWRITE (write permission) flags if such information is available. Function may set st_size (file size), st_atime, st_mtime, st_ctime (access, modification, creation times). Any other flags and members of __stat64 that didn't updated with actual file information will be set to zero (st_nlink can be set ether to 1 or zero).

Parameters

url	specifies requested file
buffer	pointer to __stat64 buffer to receive information about file

Returns

zero of success, -1 otherwise.

Implements XFILE::IFile.

StopThread()

void CFileCache::StopThread ( bool  bWait = true )

overridevirtual

Reimplemented from CThread.

---

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

• FileCache.h
• FileCache.cpp