XFILE::IFile Class Reference

#include <IFile.h>

Inheritance diagram for XFILE::IFile:

Classes
struct	ReadLineResult

Public Member Functions
	IFile ()
virtual	~IFile ()
virtual bool	Open (const CURL &url)=0
virtual bool	OpenForWrite (const CURL &url, bool bOverWrite=false)
virtual bool	ReOpen (const CURL &url)
virtual bool	Exists (const CURL &url)=0
virtual int	Stat (const CURL &url, struct __stat64 *buffer)=0
virtual int	Stat (struct __stat64 *buffer)
virtual ssize_t	Read (void *bufPtr, size_t bufSize)=0
virtual ssize_t	Write (const void *bufPtr, size_t bufSize)
virtual ReadLineResult	ReadLine (char *buffer, std::size_t bufferSize)
virtual int64_t	Seek (int64_t iFilePosition, int iWhence=SEEK_SET)=0
virtual void	Close ()=0
virtual int64_t	GetPosition ()=0
virtual int64_t	GetLength ()=0
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)
virtual int	IoControl (EIoControl request, void *param)
virtual const std::string	GetProperty (XFILE::FileProperty type, const std::string &name="") const
virtual const std::vector< std::string >	GetPropertyValues (XFILE::FileProperty type, const std::string &name="") const

Constructor & Destructor Documentation

IFile()

IFile::IFile ( )

default

~IFile()

IFile::~IFile ( )

virtualdefault

Member Function Documentation

Close()

virtual void XFILE::IFile::Close ( )

pure virtual

Implemented in ADDON::CVFSEntryIFileWrapper, XFILE::CAPKFile, XFILE::CCurlFile, XFILE::CFileAndroidApp, XFILE::CFileCache, XFILE::CFileCDDA, XFILE::CImageFile, XFILE::CISO9660File, XFILE::CMusicDatabaseFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPosixFile, XFILE::CShoutcastFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CUDFFile, XFILE::CUPnPFile, XFILE::CWin32File, XFILE::CWinLibraryFile, XFILE::CXbtFile, and XFILE::CZipFile.

Delete()

virtual bool XFILE::IFile::Delete ( const CURL & url )

inlinevirtual

Reimplemented in ADDON::CVFSEntryIFileWrapper, XFILE::CDAVFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPluginFile, XFILE::CPosixFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CWin32File, XFILE::CWin32SMBFile, and XFILE::CWinLibraryFile.

Exists()

virtual bool XFILE::IFile::Exists ( const CURL & url )

pure virtual

Implemented in ADDON::CVFSEntryIFileWrapper, XFILE::CAPKFile, XFILE::CCurlFile, XFILE::CFileAndroidApp, XFILE::CFileCache, XFILE::CFileCDDA, XFILE::CImageFile, XFILE::CISO9660File, XFILE::CMultiPathFile, XFILE::CMusicDatabaseFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPluginFile, XFILE::CPosixFile, XFILE::CShoutcastFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CUDFFile, XFILE::CUPnPFile, XFILE::CWin32File, XFILE::CWin32SMBFile, XFILE::CWinLibraryFile, XFILE::CXbtFile, and XFILE::CZipFile.

Flush()

virtual void XFILE::IFile::Flush ( )

inlinevirtual

Reimplemented in XFILE::CPipeFile, XFILE::CPosixFile, XFILE::CWin32File, and XFILE::CWinLibraryFile.

GetChunkSize()

virtual int XFILE::IFile::GetChunkSize ( )

inlinevirtual

Reimplemented in ADDON::CVFSEntryIFileWrapper, XFILE::CAPKFile, XFILE::CFileAndroidApp, XFILE::CFileCDDA, XFILE::CISO9660File, XFILE::CNFSFile, XFILE::CSMBFile, XFILE::CTVOSFile, and XFILE::CWin32File.

GetDownloadSpeed()

virtual double XFILE::IFile::GetDownloadSpeed ( )

inlinevirtual

Reimplemented in XFILE::CCurlFile.

GetLength()

virtual int64_t XFILE::IFile::GetLength ( )

pure virtual

Implemented in ADDON::CVFSEntryIFileWrapper, XFILE::CAPKFile, XFILE::CCurlFile, XFILE::CFileAndroidApp, XFILE::CFileCache, XFILE::CFileCDDA, XFILE::CImageFile, XFILE::CISO9660File, XFILE::CMusicDatabaseFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPosixFile, XFILE::CShoutcastFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CUDFFile, XFILE::CUPnPFile, XFILE::CWin32File, XFILE::CWinLibraryFile, XFILE::CXbtFile, and XFILE::CZipFile.

GetPosition()

virtual int64_t XFILE::IFile::GetPosition ( )

pure virtual

Implemented in ADDON::CVFSEntryIFileWrapper, XFILE::CAPKFile, XFILE::CCurlFile, XFILE::CFileAndroidApp, XFILE::CFileCache, XFILE::CFileCDDA, XFILE::CImageFile, XFILE::CISO9660File, XFILE::CMusicDatabaseFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPosixFile, XFILE::CShoutcastFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CUDFFile, XFILE::CUPnPFile, XFILE::CWin32File, XFILE::CWinLibraryFile, XFILE::CXbtFile, and XFILE::CZipFile.

GetProperty()

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

inlinevirtual

Reimplemented in XFILE::CCurlFile, and XFILE::CFileCache.

GetPropertyValues()

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

inlinevirtual

Reimplemented in XFILE::CCurlFile, and XFILE::CFileCache.

IoControl()

virtual int XFILE::IFile::IoControl ( EIoControl request, void * param )

inlinevirtual

Reimplemented in ADDON::CVFSEntryIFileWrapper, XFILE::CCurlFile, XFILE::CFileAndroidApp, XFILE::CFileCache, XFILE::CNFSFile, XFILE::CPipeFile, XFILE::CPosixFile, XFILE::CShoutcastFile, XFILE::CSMBFile, and XFILE::CTVOSFile.

Open()

virtual bool XFILE::IFile::Open ( const CURL & url )

pure virtual

Implemented in ADDON::CVFSEntryIFileWrapper, XFILE::CAPKFile, XFILE::CCurlFile, XFILE::CFileAndroidApp, XFILE::CFileCache, XFILE::CFileCDDA, XFILE::CImageFile, XFILE::CISO9660File, XFILE::CMultiPathFile, XFILE::CMusicDatabaseFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPluginFile, XFILE::CPosixFile, XFILE::CShoutcastFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CUDFFile, XFILE::CUPnPFile, XFILE::CWin32File, XFILE::CWin32SMBFile, XFILE::CWinLibraryFile, XFILE::CXbtFile, and XFILE::CZipFile.

OpenForWrite()

virtual bool XFILE::IFile::OpenForWrite ( const CURL & url, bool bOverWrite = false )

inlinevirtual

Reimplemented in ADDON::CVFSEntryIFileWrapper, XFILE::CCurlFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPluginFile, XFILE::CPosixFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CWin32File, XFILE::CWin32SMBFile, and XFILE::CWinLibraryFile.

Read()

virtual ssize_t XFILE::IFile::Read ( void * bufPtr, size_t bufSize )

pure virtual

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

Implemented in ADDON::CVFSEntryIFileWrapper, XFILE::CAPKFile, XFILE::CCurlFile, XFILE::CFileAndroidApp, XFILE::CFileCache, XFILE::CFileCDDA, XFILE::CImageFile, XFILE::CISO9660File, XFILE::CMusicDatabaseFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPosixFile, XFILE::CShoutcastFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CUDFFile, XFILE::CUPnPFile, XFILE::CWin32File, XFILE::CWinLibraryFile, XFILE::CXbtFile, and XFILE::CZipFile.

ReadLine()

IFile::ReadLineResult IFile::ReadLine ( char * buffer, std::size_t bufferSize )

virtual

Reads a line from a file into buffer. Reads at most bufferLength - 1 bytes from the file. buffer is unchanged in case the returned result code is FAILURE. The read line can contain '\0' characters

Parameters

buffer	The buffer into which the line is wrote
bufferSize	The size of buffer

Returns

See ReadLineResult

Reimplemented in XFILE::CCurlFile.

Rename()

virtual bool XFILE::IFile::Rename ( const CURL & url, const CURL & urlnew )

inlinevirtual

Reimplemented in ADDON::CVFSEntryIFileWrapper, XFILE::CDAVFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPluginFile, XFILE::CPosixFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CWin32File, XFILE::CWin32SMBFile, and XFILE::CWinLibraryFile.

ReOpen()

virtual bool XFILE::IFile::ReOpen ( const CURL & url )

inlinevirtual

Reimplemented in XFILE::CCurlFile.

Seek()

virtual int64_t XFILE::IFile::Seek ( int64_t iFilePosition, int iWhence = SEEK_SET )

pure virtual

Implemented in ADDON::CVFSEntryIFileWrapper, XFILE::CAPKFile, XFILE::CCurlFile, XFILE::CFileAndroidApp, XFILE::CFileCache, XFILE::CFileCDDA, XFILE::CImageFile, XFILE::CISO9660File, XFILE::CMusicDatabaseFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPosixFile, XFILE::CShoutcastFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CUDFFile, XFILE::CUPnPFile, XFILE::CWin32File, XFILE::CWinLibraryFile, XFILE::CXbtFile, and XFILE::CZipFile.

SetHidden()

virtual bool XFILE::IFile::SetHidden ( const CURL & url, bool hidden )

inlinevirtual

Reimplemented in XFILE::CWin32File, XFILE::CWin32SMBFile, and XFILE::CWinLibraryFile.

Stat() [1/2]

virtual int XFILE::IFile::Stat ( const CURL & url, struct __stat64 * buffer )

pure virtual

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.

Implemented in ADDON::CVFSEntryIFileWrapper, XFILE::CAPKFile, XFILE::CCurlFile, XFILE::CFileAndroidApp, XFILE::CFileCache, XFILE::CFileCDDA, XFILE::CImageFile, XFILE::CISO9660File, XFILE::CMultiPathFile, XFILE::CMusicDatabaseFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPluginFile, XFILE::CPosixFile, XFILE::CShoutcastFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CUDFFile, XFILE::CUPnPFile, XFILE::CWin32File, XFILE::CWin32SMBFile, XFILE::CWinLibraryFile, XFILE::CXbtFile, and XFILE::CZipFile.

Stat() [2/2]

int IFile::Stat ( struct __stat64 * buffer )

virtual

Fills struct __stat64 with information about currently open file 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

buffer

pointer to __stat64 buffer to receive information about file

Returns

zero of success, -1 otherwise.

Reimplemented in XFILE::CAPKFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPluginFile, XFILE::CPosixFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CWin32File, XFILE::CWinLibraryFile, XFILE::CXbtFile, and XFILE::CZipFile.

Truncate()

virtual int XFILE::IFile::Truncate ( int64_t size )

inlinevirtual

Reimplemented in ADDON::CVFSEntryIFileWrapper, XFILE::CNFSFile, XFILE::CPosixFile, XFILE::CSMBFile, XFILE::CWin32File, and XFILE::CWinLibraryFile.

Write()

virtual ssize_t XFILE::IFile::Write ( const void * bufPtr, size_t bufSize )

inlinevirtual

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

Parameters

bufPtr	pointer to buffer
bufSize	size of the buffer

Returns

number of successfully written bytes if any bytes were written, zero if no bytes were written and no detectable error occur, -1 in case of any explicit error

Reimplemented in ADDON::CVFSEntryIFileWrapper, XFILE::CCurlFile, XFILE::CNFSFile, XFILE::COverrideFile, XFILE::CPipeFile, XFILE::CPosixFile, XFILE::CSMBFile, XFILE::CTVOSFile, XFILE::CWin32File, and XFILE::CWinLibraryFile.

---

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

• IFile.h
• IFile.cpp